Proxy backend for dense matrix types.The DenseMatrixProxy class serves as a backend for the Proxy class. It is used in case the data type represented by the proxy is a dense matrix and augments the Proxy interface by the complete interface required of dense matrices.
More...
#include <DenseMatrixProxy.h>
Inherits blaze::DenseMatrix< PT, IsColumnMajorMatrix< MT >::value >.
|
enum | { vectorizable = MT::vectorizable
} |
| Compilation flag for intrinsic optimization.
|
|
enum | { smpAssignable = MT::smpAssignable
} |
| Compilation flag for SMP assignments.
|
|
typedef MT::ResultType | ResultType |
| Result type for expression template evaluations.
|
|
typedef MT::OppositeType | OppositeType |
| Result type with opposite storage order for expression template evaluations.
|
|
typedef MT::TransposeType | TransposeType |
| Transpose type for expression template evaluations.
|
|
typedef MT::ElementType | ElementType |
| Type of the matrix elements.
|
|
typedef MT::ReturnType | ReturnType |
| Return type for expression template evaluations.
|
|
typedef MT::CompositeType | CompositeType |
| Data type for composite expression templates.
|
|
typedef MT::Reference | Reference |
| Reference to a non-constant matrix value.
|
|
typedef MT::ConstReference | ConstReference |
| Reference to a constant matrix value.
|
|
typedef MT::Pointer | Pointer |
| Pointer to a non-constant matrix value.
|
|
typedef MT::ConstPointer | ConstPointer |
| Pointer to a constant matrix value.
|
|
typedef MT::Iterator | Iterator |
| Iterator over non-constant elements.
|
|
typedef MT::ConstIterator | ConstIterator |
| Iterator over constant elements.
|
|
typedef PT | MatrixType |
| Type of the matrix.
|
|
template<typename PT, typename MT>
class blaze::DenseMatrixProxy< PT, MT >
Proxy backend for dense matrix types.
The DenseMatrixProxy class serves as a backend for the Proxy class. It is used in case the data type represented by the proxy is a dense matrix and augments the Proxy interface by the complete interface required of dense matrices.
template<typename PT , typename MT >
Returns an iterator to the first element of row/column i of the represented matrix.
- Parameters
-
- Returns
- Iterator to the first element of row/column i.
This function returns a row/column iterator to the first element of row/column i. In case the storage order is set to rowMajor the function returns an iterator to the first element of row i, in case the storage flag is set to columnMajor the function returns an iterator to the first element of column i.
template<typename PT , typename MT >
Returns the maximum capacity of the represented matrix.
- Returns
- The capacity of the matrix.
template<typename PT , typename MT >
Returns the current capacity of the specified row/column of the represented matrix.
- Parameters
-
i | The index of the row/column. |
- Returns
- The current capacity of row/column i.
This function returns the current capacity of the specified row/column. In case the storage order is set to rowMajor the function returns the capacity of row i, in case the storage flag is set to columnMajor the function returns the capacity of column i.
template<typename PT , typename MT >
Returns an iterator to the first element of row/column i of the represented matrix.
- Parameters
-
- Returns
- Iterator to the first element of row/column i.
This function returns a row/column iterator to the first element of row/column i. In case the storage order is set to rowMajor the function returns an iterator to the first element of row i, in case the storage flag is set to columnMajor the function returns an iterator to the first element of column i.
template<typename PT , typename MT >
Returns an iterator just past the last element of row/column i of the represented matrix.
- Parameters
-
- Returns
- Iterator just past the last element of row/column i.
This function returns an row/column iterator just past the last element of row/column i. In case the storage order is set to rowMajor the function returns an iterator just past the last element of row i, in case the storage flag is set to columnMajor the function returns an iterator just past the last element of column i.
template<typename PT , typename MT >
Clearing the represented matrix.
- Returns
- void
This function clears the matrix to its default initial state.
template<typename PT , typename MT >
Returns the current number of columns of the represented matrix.
- Returns
- The number of columns of the matrix.
template<typename PT , typename MT >
In-place conjugate transpose of the represented matrix.
- Returns
- Reference to the transposed matrix.
template<typename PT , typename MT >
Low-level data access to matrix elements.
- Returns
- Pointer to the internal element storage.
This function returns a pointer to the internal storage of the dense matrix. Note that you can NOT assume that all matrix elements lie adjacent to each other! The matrix may use techniques such as padding to improve the alignment of the data. Whereas the number of elements within a row/column are given by the rows()
and columns()
member functions, respectively, the total number of elements including padding is given by the spacing()
member function.
template<typename PT , typename MT >
Low-level data access to matrix elements of row/column i.
- Returns
- Pointer to the internal element storage.
This function returns a pointer to the internal storage for the elements in row/column i.
template<typename PT , typename MT >
Returns an iterator just past the last element of row/column i of the represented matrix.
- Parameters
-
- Returns
- Iterator just past the last element of row/column i.
This function returns an row/column iterator just past the last element of row/column i. In case the storage order is set to rowMajor the function returns an iterator just past the last element of row i, in case the storage flag is set to columnMajor the function returns an iterator just past the last element of column i.
template<typename PT , typename MT >
Extending the size of the represented matrix.
- Parameters
-
m | Number of additional rows. |
n | Number of additional columns. |
preserve | true if the old values of the matrix should be preserved, false if not. |
- Returns
- void
This function increases the matrix size by m rows and n columns. Depending on the type of the matrix, during this operation new dynamic memory may be allocated in case the capacity of the matrix is too small. Therefore this function potentially changes all matrix elements. In order to preserve the old matrix values, the preserve flag can be set to true. However, note that depending on the type of the matrix new matrix elements may not initialized!
template<typename PT , typename MT >
Returns the number of non-zero elements in the represented matrix.
- Returns
- The number of non-zero elements in the matrix.
template<typename PT , typename MT >
Returns the number of non-zero elements in the specified row/column of the represented matrix.
- Parameters
-
i | The index of the row/column. |
- Returns
- The number of non-zero elements of row/column i.
This function returns the current number of non-zero elements in the specified row/column. In case the storage order is set to rowMajor the function returns the number of non-zero elements in row i, in case the storage flag is set to columnMajor the function returns the number of non-zero elements in column i.
template<typename PT , typename MT >
Function call operator for the direct access to matrix elements.
- Parameters
-
i | Access index for the row. The index has to be in the range . |
j | Access index for the column. The index has to be in the range . |
- Returns
- Reference to the accessed value.
Conversion operator for non-constant matrices.
- Returns
- Reference of the actual type of the matrix.
Conversion operator for constant matrices.
- Returns
- Constant reference of the actual type of the matrix.
template<typename PT , typename MT >
Setting the minimum capacity of the represented matrix.
- Parameters
-
n | The new minimum capacity of the matrix. |
- Returns
- void
This function increases the capacity of the dense matrix to at least n elements. The current values of the matrix elements are preserved.
template<typename PT , typename MT >
Reset to the default initial value.
- Returns
- void
This function resets all elements of the matrix to the default initial values.
template<typename PT , typename MT >
Reset the specified row/column to the default initial values.
- Parameters
-
i | The index of the row/column. |
- Returns
- void
This function resets the values in the specified row/column to their default value. In case the storage order is set to rowMajor the function resets the values in row i, in case the storage order is set to columnMajor the function resets the values in column i. Note that the capacity of the row/column remains unchanged.
template<typename PT , typename MT >
Changing the size of the represented matrix.
- Parameters
-
m | The new number of rows of the matrix. |
n | The new number of columns of the matrix. |
preserve | true if the old values of the matrix should be preserved, false if not. |
- Returns
- void
This function resizes the matrix using the given size to
. Depending on the type of the matrix, during this operation new dynamic memory may be allocated in case the capacity of the matrix is too small. Note that this function may invalidate all existing views (submatrices, rows, columns, ...) on the matrix if it is used to shrink the matrix. Additionally, the resize operation potentially changes all matrix elements. In order to preserve the old matrix values, the preserve flag can be set to true. However, note that depending on the type of the matrix new matrix elements may not initialized!
template<typename PT , typename MT >
Returns the current number of rows of the represented matrix.
- Returns
- The number of rows of the matrix.
template<typename PT , typename MT >
template<typename Other >
Scaling of the matrix by the scalar value scalar (
).
- Parameters
-
scalar | The scalar value for the matrix scaling. |
- Returns
- void
template<typename PT , typename MT >
Returns the spacing between the beginning of two rows/columns of the represented matrix.
- Returns
- The spacing between the beginning of two rows/columns.
This function returns the spacing between the beginning of two rows/columns, i.e. the total number of elements of a row/column. In case the storage order is set to rowMajor the function returns the spacing between two rows, in case the storage flag is set to columnMajor the function returns the spacing between two columns.
template<typename PT , typename MT >
In-place transpose of the represented matrix.
- Returns
- Reference to the transposed matrix.
The documentation for this class was generated from the following file: