![]() |
Efficient implementation of a fixed-sized matrix.The StaticMatrix class template is the representation of a fixed-size matrix with statically allocated elements of arbitrary type. The type of the elements, the number of rows and columns and the storage order of the matrix can be specified via the four template parameters: More...
#include <StaticMatrix.h>
Inherits blaze::DenseMatrix< StaticMatrix< Type, M, N, SO >, SO >.
Classes | |
struct | Rebind |
Rebind mechanism to obtain a StaticMatrix with different data/element type. More... | |
struct | Resize |
Resize mechanism to obtain a StaticMatrix with different fixed dimensions. More... | |
Public Types | |
using | This = StaticMatrix< Type, M, N, SO > |
Type of this StaticMatrix instance. | |
using | BaseType = DenseMatrix< This, SO > |
Base type of this StaticMatrix instance. | |
using | ResultType = This |
Result type for expression template evaluations. | |
using | OppositeType = StaticMatrix< Type, M, N,!SO > |
Result type with opposite storage order for expression template evaluations. | |
using | TransposeType = StaticMatrix< Type, N, M,!SO > |
Transpose type for expression template evaluations. | |
using | ElementType = Type |
Type of the matrix elements. | |
using | SIMDType = SIMDTrait_t< ElementType > |
SIMD type of the matrix elements. | |
using | ReturnType = const Type & |
Return type for expression template evaluations. | |
using | CompositeType = const This & |
Data type for composite expression templates. | |
using | Reference = Type & |
Reference to a non-constant matrix value. | |
using | ConstReference = const Type & |
Reference to a constant matrix value. | |
using | Pointer = Type * |
Pointer to a non-constant matrix value. | |
using | ConstPointer = const Type * |
Pointer to a constant matrix value. | |
using | Iterator = DenseIterator< Type, align > |
Iterator over non-constant elements. | |
using | ConstIterator = DenseIterator< const Type, align > |
Iterator over constant elements. | |
using | MatrixType = MT |
Type of the matrix. | |
Public Member Functions | |
template<typename Other , size_t Rows, size_t Cols> | |
StaticMatrix< Type, M, N, SO > & | operator= (const Other(&array)[Rows][Cols]) |
Array assignment to all matrix elements. More... | |
template<typename Other , bool SO2> | |
StaticMatrix< Type, M, N, SO > & | operator= (const StaticMatrix< Other, M, N, SO2 > &rhs) |
Assignment operator for different StaticMatrix instances. More... | |
template<typename MT , bool SO2> | |
StaticMatrix< Type, M, N, SO > & | operator= (const Matrix< MT, SO2 > &rhs) |
Assignment operator for different matrices. More... | |
template<typename MT , bool SO2> | |
StaticMatrix< Type, M, N, SO > & | operator+= (const Matrix< MT, SO2 > &rhs) |
Addition assignment operator for the addition of a matrix ( ![]() | |
template<typename MT , bool SO2> | |
StaticMatrix< Type, M, N, SO > & | operator-= (const Matrix< MT, SO2 > &rhs) |
Subtraction assignment operator for the subtraction of a matrix ( ![]() | |
template<typename MT , bool SO2> | |
StaticMatrix< Type, M, N, SO > & | operator%= (const Matrix< MT, SO2 > &rhs) |
Schur product assignment operator for the multiplication of a matrix ( ![]() | |
template<typename Other > | |
StaticMatrix< Type, M, N, SO > & | scale (const Other &scalar) |
Scaling of the matrix by the scalar value scalar ( ![]() | |
BLAZE_ALWAYS_INLINE constexpr MatrixType & | operator~ () noexcept |
Conversion operator for non-constant matrices. More... | |
BLAZE_ALWAYS_INLINE constexpr const MatrixType & | operator~ () const noexcept |
Conversion operator for constant matrices. More... | |
Constructors | |
StaticMatrix () | |
The default constructor for StaticMatrix. More... | |
StaticMatrix (const Type &init) | |
Constructor for a homogenous initialization of all elements. More... | |
constexpr | StaticMatrix (initializer_list< initializer_list< Type > > list) |
List initialization of all matrix elements. More... | |
template<typename Other > | |
StaticMatrix (size_t m, size_t n, const Other *array) | |
Array initialization of all matrix elements. More... | |
template<typename Other , size_t Rows, size_t Cols> | |
StaticMatrix (const Other(&array)[Rows][Cols]) | |
Array initialization of all matrix elements. More... | |
constexpr | StaticMatrix (const StaticMatrix &m) |
The copy constructor for StaticMatrix. More... | |
template<typename Other , bool SO2> | |
StaticMatrix (const StaticMatrix< Other, M, N, SO2 > &m) | |
Conversion constructor from different StaticMatrix instances. More... | |
template<typename MT , bool SO2> | |
StaticMatrix (const Matrix< MT, SO2 > &m) | |
Conversion constructor from different matrices. More... | |
Destructor | |
~StaticMatrix ()=default | |
Data access functions | |
constexpr Reference | operator() (size_t i, size_t j) noexcept |
2D-access to the matrix elements. More... | |
constexpr ConstReference | operator() (size_t i, size_t j) const noexcept |
2D-access to the matrix elements. More... | |
Reference | at (size_t i, size_t j) |
Checked access to the matrix elements. More... | |
ConstReference | at (size_t i, size_t j) const |
Checked access to the matrix elements. More... | |
constexpr Pointer | data () noexcept |
Low-level data access to the matrix elements. More... | |
constexpr ConstPointer | data () const noexcept |
Low-level data access to the matrix elements. More... | |
constexpr Pointer | data (size_t i) noexcept |
Low-level data access to the matrix elements of row/column i. More... | |
constexpr ConstPointer | data (size_t i) const noexcept |
Low-level data access to the matrix elements of row/column i. More... | |
constexpr Iterator | begin (size_t i) noexcept |
Returns an iterator to the first element of row/column i. More... | |
constexpr ConstIterator | begin (size_t i) const noexcept |
Returns an iterator to the first element of row/column i. More... | |
constexpr ConstIterator | cbegin (size_t i) const noexcept |
Returns an iterator to the first element of row/column i. More... | |
constexpr Iterator | end (size_t i) noexcept |
Returns an iterator just past the last element of row/column i. More... | |
constexpr ConstIterator | end (size_t i) const noexcept |
Returns an iterator just past the last element of row/column i. More... | |
constexpr ConstIterator | cend (size_t i) const noexcept |
Returns an iterator just past the last element of row/column i. More... | |
Assignment operators | |
constexpr StaticMatrix & | operator= (const Type &set) |
Homogenous assignment to all matrix elements. More... | |
constexpr StaticMatrix & | operator= (initializer_list< initializer_list< Type > > list) |
List assignment to all matrix elements. More... | |
template<typename Other , size_t Rows, size_t Cols> | |
StaticMatrix & | operator= (const Other(&array)[Rows][Cols]) |
constexpr StaticMatrix & | operator= (const StaticMatrix &rhs) |
Copy assignment operator for StaticMatrix. More... | |
template<typename Other , bool SO2> | |
StaticMatrix & | operator= (const StaticMatrix< Other, M, N, SO2 > &rhs) |
template<typename MT , bool SO2> | |
StaticMatrix & | operator= (const Matrix< MT, SO2 > &rhs) |
template<typename MT , bool SO2> | |
StaticMatrix & | operator+= (const Matrix< MT, SO2 > &rhs) |
template<typename MT , bool SO2> | |
StaticMatrix & | operator-= (const Matrix< MT, SO2 > &rhs) |
template<typename MT , bool SO2> | |
StaticMatrix & | operator%= (const Matrix< MT, SO2 > &rhs) |
Numeric functions | |
StaticMatrix & | transpose () |
In-place transpose of the matrix. More... | |
StaticMatrix & | ctranspose () |
In-place conjugate transpose of the matrix. More... | |
template<typename Other > | |
StaticMatrix & | scale (const Other &scalar) |
Debugging functions | |
constexpr bool | isIntact () const noexcept |
Returns whether the invariants of the static matrix are intact. More... | |
Static Public Member Functions | |
Memory functions | |
static void * | operator new (std::size_t size) |
Class specific implementation of operator new. More... | |
static void * | operator new[] (std::size_t size) |
Class specific implementation of operator new[]. More... | |
static void * | operator new (std::size_t size, const std::nothrow_t &) |
Class specific implementation of the no-throw operator new. More... | |
static void * | operator new[] (std::size_t size, const std::nothrow_t &) |
Class specific implementation of the no-throw operator new[]. More... | |
static void | operator delete (void *ptr) |
Class specific implementation of operator delete. More... | |
static void | operator delete[] (void *ptr) |
Class specific implementation of operator delete[]. More... | |
static void | operator delete (void *ptr, const std::nothrow_t &) |
Class specific implementation of no-throw operator delete. More... | |
static void | operator delete[] (void *ptr, const std::nothrow_t &) |
Class specific implementation of no-throw operator delete[]. More... | |
Static Public Attributes | |
static constexpr bool | simdEnabled = IsVectorizable_v<Type> |
Compilation flag for SIMD optimization. More... | |
static constexpr bool | smpAssignable = false |
Compilation flag for SMP assignments. More... | |
static constexpr bool | storageOrder = SO |
Storage order of the matrix. | |
Private Types | |
using | AlignedStorage = AlignedArray< Type, M *NN, Alignment > |
Type of the aligned storage. | |
Private Attributes | |
Member variables | |
AlignedStorage | v_ |
The statically allocated matrix elements. More... | |
Static Private Attributes | |
static constexpr size_t | SIMDSIZE = SIMDTrait<Type>::size |
The number of elements packed within a single SIMD vector. | |
static constexpr size_t | NN = ( usePadding ? nextMultiple( N, SIMDSIZE ) : N ) |
Alignment adjustment. | |
static constexpr bool | align = ( usePadding || NN % SIMDSIZE == 0UL ) |
Compilation switch for the choice of alignment. | |
static constexpr size_t | Alignment |
Alignment of the data elements. More... | |
Utility functions | |
size_t | capacity (size_t i) const noexcept |
Returns the current capacity of the specified row/column. More... | |
size_t | nonZeros () const |
Returns the total number of non-zero elements in the matrix. More... | |
size_t | nonZeros (size_t i) const |
Returns the number of non-zero elements in the specified row/column. More... | |
constexpr void | reset () |
Reset to the default initial values. More... | |
void | reset (size_t i) |
Reset the specified row/column to the default initial values. More... | |
void | swap (StaticMatrix &m) noexcept |
Swapping the contents of two static matrices. More... | |
static constexpr size_t | rows () noexcept |
Returns the current number of rows of the matrix. More... | |
static constexpr size_t | columns () noexcept |
Returns the current number of columns of the matrix. More... | |
static constexpr size_t | spacing () noexcept |
Returns the spacing between the beginning of two rows. More... | |
static constexpr size_t | capacity () noexcept |
Returns the maximum capacity of the matrix. More... | |
Expression template evaluation functions | |
template<typename Other > | |
bool | canAlias (const Other *alias) const noexcept |
Returns whether the matrix can alias with the given address alias. More... | |
template<typename Other > | |
bool | isAliased (const Other *alias) const noexcept |
Returns whether the matrix is aliased with the given address alias. More... | |
BLAZE_ALWAYS_INLINE SIMDType | load (size_t i, size_t j) const noexcept |
Load of a SIMD element of the matrix. More... | |
BLAZE_ALWAYS_INLINE SIMDType | loada (size_t i, size_t j) const noexcept |
Aligned load of a SIMD element of the matrix. More... | |
BLAZE_ALWAYS_INLINE SIMDType | loadu (size_t i, size_t j) const noexcept |
Unaligned load of a SIMD element of the matrix. More... | |
BLAZE_ALWAYS_INLINE void | store (size_t i, size_t j, const SIMDType &value) noexcept |
Store of a SIMD element of the matrix. More... | |
BLAZE_ALWAYS_INLINE void | storea (size_t i, size_t j, const SIMDType &value) noexcept |
Aligned store of a SIMD element of the matrix. More... | |
BLAZE_ALWAYS_INLINE void | storeu (size_t i, size_t j, const SIMDType &value) noexcept |
Unaligned store of a SIMD element of the matrix. More... | |
BLAZE_ALWAYS_INLINE void | stream (size_t i, size_t j, const SIMDType &value) noexcept |
Aligned, non-temporal store of a SIMD element of the matrix. More... | |
template<typename MT , bool SO2> | |
auto | assign (const DenseMatrix< MT, SO2 > &rhs) -> DisableIf_t< VectorizedAssign_v< MT > > |
Default implementation of the assignment of a dense matrix. More... | |
template<typename MT , bool SO2> | |
auto | assign (const DenseMatrix< MT, SO2 > &rhs) -> EnableIf_t< VectorizedAssign_v< MT > > |
template<typename MT > | |
void | assign (const SparseMatrix< MT, SO > &rhs) |
Default implementation of the assignment of a row-major sparse matrix. More... | |
template<typename MT > | |
void | assign (const SparseMatrix< MT,!SO > &rhs) |
Default implementation of the assignment of a column-major sparse matrix. More... | |
template<typename MT , bool SO2> | |
auto | addAssign (const DenseMatrix< MT, SO2 > &rhs) -> DisableIf_t< VectorizedAddAssign_v< MT > > |
Default implementation of the addition assignment of a row-major dense matrix. More... | |
template<typename MT , bool SO2> | |
auto | addAssign (const DenseMatrix< MT, SO2 > &rhs) -> EnableIf_t< VectorizedAddAssign_v< MT > > |
template<typename MT > | |
void | addAssign (const SparseMatrix< MT, SO > &rhs) |
Default implementation of the addition assignment of a row-major sparse matrix. More... | |
template<typename MT > | |
void | addAssign (const SparseMatrix< MT,!SO > &rhs) |
Default implementation of the addition assignment of a column-major sparse matrix. More... | |
template<typename MT , bool SO2> | |
auto | subAssign (const DenseMatrix< MT, SO2 > &rhs) -> DisableIf_t< VectorizedSubAssign_v< MT > > |
Default implementation of the subtraction assignment of a dense matrix. More... | |
template<typename MT , bool SO2> | |
auto | subAssign (const DenseMatrix< MT, SO2 > &rhs) -> EnableIf_t< VectorizedSubAssign_v< MT > > |
template<typename MT > | |
void | subAssign (const SparseMatrix< MT, SO > &rhs) |
Default implementation of the subtraction assignment of a row-major sparse matrix. More... | |
template<typename MT > | |
void | subAssign (const SparseMatrix< MT,!SO > &rhs) |
Default implementation of the subtraction assignment of a column-major sparse matrix. More... | |
template<typename MT , bool SO2> | |
auto | schurAssign (const DenseMatrix< MT, SO2 > &rhs) -> DisableIf_t< VectorizedSchurAssign_v< MT > > |
Default implementation of the Schur product assignment of a dense matrix. More... | |
template<typename MT , bool SO2> | |
auto | schurAssign (const DenseMatrix< MT, SO2 > &rhs) -> EnableIf_t< VectorizedSchurAssign_v< MT > > |
template<typename MT > | |
void | schurAssign (const SparseMatrix< MT, SO > &rhs) |
Default implementation of the Schur product assignment of a row-major sparse matrix. More... | |
template<typename MT > | |
void | schurAssign (const SparseMatrix< MT,!SO > &rhs) |
Default implementation of the Schur product assignment of a column-major sparse matrix. More... | |
static constexpr bool | isAligned () noexcept |
Returns whether the matrix is properly aligned in memory. More... | |
Efficient implementation of a fixed-sized matrix.
The StaticMatrix class template is the representation of a fixed-size matrix with statically allocated elements of arbitrary type. The type of the elements, the number of rows and columns and the storage order of the matrix can be specified via the four template parameters:
Depending on the storage order, the matrix elements are either stored in a row-wise fashion or in a column-wise fashion. Given the 2x3 matrix
in case of row-major order the elements are stored in the order
In case of column-major order the elements are stored in the order
The use of StaticMatrix is very natural and intuitive. All operations (addition, subtraction, multiplication, scaling, ...) can be performed on all possible combinations of row-major and column-major dense and sparse matrices with fitting element types. The following example gives an impression of the use of StaticMatrix:
|
inlineexplicit |
The default constructor for StaticMatrix.
All matrix elements are initialized to the default value (i.e. 0 for integral data types).
|
inlineexplicit |
Constructor for a homogenous initialization of all elements.
init | Initial value for all matrix elements. |
|
inlineexplicit |
List initialization of all matrix elements.
list | The initializer list. |
std::invalid_argument | Invalid setup of static matrix. |
This constructor provides the option to explicitly initialize the elements of the matrix by means of an initializer list:
The matrix elements are (copy) assigned the values of the given initializer list. Missing values are initialized as default (as e.g. the value 6 in the example). Note that in case the size of the top-level initializer list does not match the number of rows of the matrix or the size of any nested list exceeds the number of columns, a std::invalid_argument exception is thrown.
|
inlineexplicit |
Array initialization of all matrix elements.
m | The number of rows of the matrix. |
n | The number of columns of the matrix. |
array | Dynamic array for the initialization. |
This constructor offers the option to directly initialize the elements of the matrix with a dynamic array:
The matrix is initialized with the values from the given array. Missing values are initialized with default values. In case the specified number of rows and/or columns exceeds the maximum number of rows/column of the static matrix (i.e. m is larger than M or n is larger than N), a std::invalid_argument exception is thrown.
Note that it is expected that the given array has at least m by n elements. Providing an array with less elements results in undefined behavior!
|
inlineexplicit |
Array initialization of all matrix elements.
array | ![]() |
This constructor offers the option to directly initialize the elements of the matrix with a static array:
The matrix is initialized with the values from the given array. Missing values are initialized with default values (as e.g. the value 6 in the example).
|
inline |
The copy constructor for StaticMatrix.
m | Matrix to be copied. |
The copy constructor is explicitly defined in order to enable/facilitate NRV optimization.
|
inline |
Conversion constructor from different StaticMatrix instances.
m | Matrix to be copied. |
|
inline |
Conversion constructor from different matrices.
m | Matrix to be copied. |
std::invalid_argument | Invalid setup of static matrix. |
This constructor initializes the static matrix from the given matrix. In case the size of the given matrix does not match the size of the static matrix (i.e. the number of rows is not M or the number of columns is not N), a std::invalid_argument exception is thrown.
|
inline |
Default implementation of the addition assignment of a row-major dense matrix.
SIMD optimized implementation of the addition assignment of a dense matrix.
rhs | The right-hand side dense matrix to be added. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the addition assignment of a row-major sparse matrix.
rhs | The right-hand side sparse matrix to be added. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the addition assignment of a column-major sparse matrix.
rhs | The right-hand side sparse matrix to be added. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the assignment of a dense matrix.
SIMD optimized implementation of the assignment of a dense matrix.
rhs | The right-hand side dense matrix to be assigned. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the assignment of a row-major sparse matrix.
rhs | The right-hand side sparse matrix to be assigned. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the assignment of a column-major sparse matrix.
rhs | The right-hand side sparse matrix to be assigned. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Checked access to the matrix elements.
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 ![]() |
std::out_of_range | Invalid matrix access index. |
In contrast to the subscript operator this function always performs a check of the given access indices.
|
inline |
Checked access to the matrix elements.
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 ![]() |
std::out_of_range | Invalid matrix access index. |
In contrast to the subscript operator this function always performs a check of the given access indices.
|
inlinenoexcept |
Returns an iterator to the first element of row/column i.
i | The row/column index. |
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.
|
inlinenoexcept |
Returns an iterator to the first element of row/column i.
i | The row/column index. |
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.
|
inlinenoexcept |
Returns whether the matrix can alias with the given address alias.
alias | The alias to be checked. |
This function returns whether the given address can alias with the matrix. In contrast to the isAliased() function this function is allowed to use compile time expressions to optimize the evaluation.
|
inlinestaticnoexcept |
Returns the maximum capacity of the matrix.
|
inlinenoexcept |
Returns the current capacity of the specified row/column.
i | The index of the row/column. |
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.
|
inlinenoexcept |
Returns an iterator to the first element of row/column i.
i | The row/column index. |
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.
|
inlinenoexcept |
Returns an iterator just past the last element of row/column i.
i | The row/column index. |
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.
|
inlinestaticnoexcept |
Returns the current number of columns of the matrix.
|
inline |
In-place conjugate transpose of the matrix.
This function transposes the static matrix in-place. Note that this function can only be used for square static matrices, i.e. if M is equal to N.
|
inlinenoexcept |
Low-level data access to the matrix elements.
This function returns a pointer to the internal storage of the static matrix. Note that you can NOT assume that all matrix elements lie adjacent to each other! The static 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.
|
inlinenoexcept |
Low-level data access to the matrix elements.
This function returns a pointer to the internal storage of the static matrix. Note that you can NOT assume that all matrix elements lie adjacent to each other! The static 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.
|
inlinenoexcept |
Low-level data access to the matrix elements of row/column i.
i | The row/column index. |
This function returns a pointer to the internal storage for the elements in row/column i.
|
inlinenoexcept |
Low-level data access to the matrix elements of row/column i.
i | The row/column index. |
This function returns a pointer to the internal storage for the elements in row/column i.
|
inlinenoexcept |
Returns an iterator just past the last element of row/column i.
i | The row/column index. |
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.
|
inlinenoexcept |
Returns an iterator just past the last element of row/column i.
i | The row/column index. |
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.
|
inlinenoexcept |
Returns whether the matrix is aliased with the given address alias.
alias | The alias to be checked. |
This function returns whether the given address is aliased with the matrix. In contrast to the canAlias() function this function is not allowed to use compile time expressions to optimize the evaluation.
|
inlinestaticnoexcept |
Returns whether the matrix is properly aligned in memory.
This function returns whether the matrix is guaranteed to be properly aligned in memory, i.e. whether the beginning and the end of each row/column of the matrix are guaranteed to conform to the alignment restrictions of the element type Type.
|
inlinenoexcept |
Returns whether the invariants of the static matrix are intact.
This function checks whether the invariants of the static matrix are intact, i.e. if its state is valid. In case the invariants are intact, the function returns true, else it will return false.
|
noexcept |
Load of a SIMD element of the matrix.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
This function performs a load of a specific SIMD element of the dense matrix. The row index must be smaller than the number of rows and the column index must be smaller then the number of columns. Additionally, the column index (in case of a row-major matrix) or the row index (in case of a column-major matrix) must be a multiple of the number of values inside the SIMD element. This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors.
|
noexcept |
Aligned load of a SIMD element of the matrix.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
This function performs an aligned load of a specific SIMD element of the dense matrix. The row index must be smaller than the number of rows and the column index must be smaller than the number of columns. Additionally, the column index (in case of a row-major matrix) or the row index (in case of a column-major matrix) must be a multiple of the number of values inside the SIMD element. This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors.
|
noexcept |
Unaligned load of a SIMD element of the matrix.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
This function performs an unaligned load of a specific SIMD element of the dense matrix. The row index must be smaller than the number of rows and the column index must be smaller than the number of columns. Additionally, the column index (in case of a row-major matrix) or the row index (in case of a column-major matrix) must be a multiple of the number of values inside the SIMD element. This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors.
|
inline |
Returns the total number of non-zero elements in the matrix.
|
inline |
Returns the number of non-zero elements in the specified row/column.
i | The index of the row/column. |
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.
|
inlinestatic |
Class specific implementation of operator delete.
ptr | The memory to be deallocated. |
|
inlinestatic |
Class specific implementation of no-throw operator delete.
ptr | The memory to be deallocated. |
|
inlinestatic |
Class specific implementation of operator delete[].
ptr | The memory to be deallocated. |
|
inlinestatic |
Class specific implementation of no-throw operator delete[].
ptr | The memory to be deallocated. |
|
inlinestatic |
Class specific implementation of operator new.
size | The total number of bytes to be allocated. |
std::bad_alloc | Allocation failed. |
This class-specific implementation of operator new provides the functionality to allocate dynamic memory based on the alignment restrictions of the StaticMatrix class template.
|
inlinestatic |
Class specific implementation of the no-throw operator new.
size | The total number of bytes to be allocated. |
std::bad_alloc | Allocation failed. |
This class-specific implementation of operator new provides the functionality to allocate dynamic memory based on the alignment restrictions of the StaticMatrix class template.
|
inlinestatic |
Class specific implementation of operator new[].
size | The total number of bytes to be allocated. |
std::bad_alloc | Allocation failed. |
This class-specific implementation of operator new provides the functionality to allocate dynamic memory based on the alignment restrictions of the StaticMatrix class template.
|
inlinestatic |
Class specific implementation of the no-throw operator new[].
size | The total number of bytes to be allocated. |
std::bad_alloc | Allocation failed. |
This class-specific implementation of operator new provides the functionality to allocate dynamic memory based on the alignment restrictions of the StaticMatrix class template.
|
inline |
Schur product assignment operator for the multiplication of a matrix ( ).
rhs | The right-hand side matrix for the Schur product. |
std::invalid_argument | Matrix sizes do not match. |
In case the current sizes of the two matrices don't match, a std::invalid_argument exception is thrown.
|
inlinenoexcept |
2D-access to the matrix elements.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
This function only performs an index check in case BLAZE_USER_ASSERT() is active. In contrast, the at() function is guaranteed to perform a check of the given access indices.
|
inlinenoexcept |
2D-access to the matrix elements.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
This function only performs an index check in case BLAZE_USER_ASSERT() is active. In contrast, the at() function is guaranteed to perform a check of the given access indices.
|
inline |
Addition assignment operator for the addition of a matrix ( ).
rhs | The right-hand side matrix to be added to the matrix. |
std::invalid_argument | Matrix sizes do not match. |
In case the current sizes of the two matrices don't match, a std::invalid_argument exception is thrown.
|
inline |
Subtraction assignment operator for the subtraction of a matrix ( ).
rhs | The right-hand side matrix to be subtracted from the matrix. |
std::invalid_argument | Matrix sizes do not match. |
In case the current sizes of the two matrices don't match, a std::invalid_argument exception is thrown.
|
inline |
Homogenous assignment to all matrix elements.
set | Scalar value to be assigned to all matrix elements. |
|
inline |
List assignment to all matrix elements.
list | The initializer list. |
std::invalid_argument | Invalid assignment to static matrix. |
This assignment operator offers the option to directly assign to all elements of the matrix by means of an initializer list:
The matrix elements are (copy) assigned the values from the given initializer list. Missing values are initialized as default (as e.g. the value 6 in the example). Note that in case the size of the top-level initializer list does not match the number of rows of the matrix or the size of any nested list exceeds the number of columns, a std::invalid_argument exception is thrown.
|
inline |
Copy assignment operator for StaticMatrix.
rhs | Matrix to be copied. |
Explicit definition of a copy assignment operator for performance reasons.
|
inline |
Array assignment to all matrix elements.
array | ![]() |
This assignment operator offers the option to directly set all elements of the matrix:
The matrix is assigned the values from the given array. Missing values are initialized with default values (as e.g. the value 6 in the example).
|
inline |
Assignment operator for different StaticMatrix instances.
rhs | Matrix to be copied. |
|
inline |
Assignment operator for different matrices.
rhs | Matrix to be copied. |
std::invalid_argument | Invalid assignment to static matrix. |
This constructor initializes the matrix as a copy of the given matrix. In case the number of rows of the given matrix is not M or the number of columns is not N, a std::invalid_argument exception is thrown.
|
inlinenoexceptinherited |
Conversion operator for non-constant matrices.
|
inlinenoexceptinherited |
Conversion operator for constant matrices.
|
inline |
Reset to the default initial values.
|
inline |
Reset the specified row/column to the default initial values.
i | The index of the row/column. |
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.
|
inlinestaticnoexcept |
Returns the current number of rows of the matrix.
|
inline |
Scaling of the matrix by the scalar value scalar ( ).
scalar | The scalar value for the matrix scaling. |
This function scales the matrix by applying the given scalar value scalar to each element of the matrix. For built-in and complex
data types it has the same effect as using the multiplication assignment operator:
|
inline |
Default implementation of the Schur product assignment of a dense matrix.
SIMD optimized implementation of the Schur product assignment of a dense matrix.
rhs | The right-hand side dense matrix for the Schur product. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the Schur product assignment of a row-major sparse matrix.
rhs | The right-hand side sparse matrix for the Schur product. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the Schur product assignment of a column-major sparse matrix.
rhs | The right-hand side sparse matrix for the Schur product. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inlinestaticnoexcept |
Returns the spacing between the beginning of two rows.
This function returns the spacing between the beginning of two rows, i.e. the total number of elements of a row.
|
noexcept |
Store of a SIMD element of the matrix.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
value | The SIMD element to be stored. |
This function performs a store of a specific SIMD element of the dense matrix. The row index must be smaller than the number of rows and the column index must be smaller than the number of columns. Additionally, the column index (in case of a row-major matrix) or the row index (in case of a column-major matrix) must be a multiple of the number of values inside the SIMD element. This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors.
|
noexcept |
Aligned store of a SIMD element of the matrix.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
value | The SIMD element to be stored. |
This function performs an aligned store of a specific SIMD element of the dense matrix. The row index must be smaller than the number of rows and the column index must be smaller than the number of columns. Additionally, the column index (in case of a row-major matrix) or the row index (in case of a column-major matrix) must be a multiple of the number of values inside the SIMD element. This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors.
|
noexcept |
Unaligned store of a SIMD element of the matrix.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
value | The SIMD element to be stored. |
This function performs an unaligned store of a specific SIMD element of the dense matrix. The row index must be smaller than the number of rows and the column index must be smaller than the number of columns. Additionally, the column index (in case of a row-major matrix) or the row index (in case of a column-major matrix) must be a multiple of the number of values inside the SIMD element. This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors.
|
noexcept |
Aligned, non-temporal store of a SIMD element of the matrix.
i | Access index for the row. The index has to be in the range [0..M-1]. |
j | Access index for the column. The index has to be in the range [0..N-1]. |
value | The SIMD element to be stored. |
This function performs an aligned, non-temporal store of a specific SIMD element of the dense matrix. The row index must be smaller than the number of rows and the column index must be smaller than the number of columns. Additionally, the column index (in case of a row-major matrix) or the row index (in case of a column-major matrix) must be a multiple of the number of values inside the SIMD element. This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors.
|
inline |
Default implementation of the subtraction assignment of a dense matrix.
SIMD optimized implementation of the subtraction assignment of a dense matrix.
rhs | The right-hand side dense matrix to be subtracted. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the subtraction assignment of a row-major sparse matrix.
rhs | The right-hand side sparse matrix to be subtracted. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inline |
Default implementation of the subtraction assignment of a column-major sparse matrix.
rhs | The right-hand side sparse matrix to be subtracted. |
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.
|
inlinenoexcept |
Swapping the contents of two static matrices.
m | The matrix to be swapped. |
|
inline |
In-place transpose of the matrix.
This function transposes the static matrix in-place. Note that this function can only be used for square static matrices, i.e. if M is equal to N.
|
staticprivate |
Alignment of the data elements.
|
static |
Compilation flag for SIMD optimization.
The simdEnabled compilation flag indicates whether expressions the matrix is involved in can be optimized via SIMD operations. In case the element type of the matrix is a vectorizable data type, the simdEnabled compilation flag is set to true, otherwise it is set to false.
|
static |
Compilation flag for SMP assignments.
The smpAssignable compilation flag indicates whether the matrix can be used in SMP (shared memory parallel) assignments (both on the left-hand and right-hand side of the assignment).
|
private |
The statically allocated matrix elements.
Access to the matrix elements is gained via the function call operator. In case of row-major order the memory layout of the elements is
.