![]() |
Classes | |
class | blaze::Submatrix< MT, AF, SO, DF > |
View on a specific submatrix of a dense or sparse matrix.The Submatrix class template represents a view on a specific submatrix of a dense or sparse matrix primitive. The type of the matrix is specified via the first template parameter: More... | |
Submatrix operators | |
template<typename MT , bool AF, bool SO, bool DF> | |
void | blaze::reset (Submatrix< MT, AF, SO, DF > &sm) |
Resetting the given submatrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
void | blaze::reset (Submatrix< MT, AF, SO, DF > &&sm) |
Resetting the given temporary submatrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
void | blaze::reset (Submatrix< MT, AF, SO, DF > &sm, size_t i) |
Reset the specified row/column of the given submatrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
void | blaze::clear (Submatrix< MT, AF, SO, DF > &sm) |
Clearing the given matrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
void | blaze::clear (Submatrix< MT, AF, SO, DF > &&sm) |
Clearing the given temporary matrix. More... | |
template<bool RF, typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isDefault (const Submatrix< MT, AF, SO, DF > &sm) |
Returns whether the given submatrix is in default state. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isIntact (const Submatrix< MT, AF, SO, DF > &sm) noexcept |
Returns whether the invariants of the given submatrix are intact. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isSymmetric (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is symmetric. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isHermitian (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is Hermitian. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isLower (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is a lower triangular matrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isUniLower (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is a lower unitriangular matrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isStrictlyLower (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is a strictly lower triangular matrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isUpper (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is an upper triangular matrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isUniUpper (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is an upper unitriangular matrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isStrictlyUpper (const Submatrix< MT, AF, SO, DF > &sm) |
Checks if the given submatrix is a strictly upper triangular matrix. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isSame (const Submatrix< MT, AF, SO, DF > &a, const Matrix< MT, SO > &b) noexcept |
Returns whether the given matrix and submatrix represent the same observable state. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isSame (const Matrix< MT, SO > &a, const Submatrix< MT, AF, SO, DF > &b) noexcept |
Returns whether the given matrix and submatrix represent the same observable state. More... | |
template<typename MT , bool AF, bool SO, bool DF> | |
bool | blaze::isSame (const Submatrix< MT, AF, SO, DF > &a, const Submatrix< MT, AF, SO, DF > &b) noexcept |
Returns whether the two given submatrices represent the same observable state. More... | |
|
inline |
Clearing the given matrix.
sm | The matrix to be cleared. |
Clearing a submatrix is equivalent to resetting it via the reset() function.
|
inline |
Clearing the given temporary matrix.
sm | The temporary matrix to be cleared. |
Clearing a submatrix is equivalent to resetting it via the reset() function.
|
inline |
Returns whether the given submatrix is in default state.
sm | The submatrix to be tested for its default state. |
This function checks whether the submatrix is in default state. For instance, in case the submatrix is instantiated for a built-in integral or floating point data type, the function returns true in case all submatrix elements are 0 and false in case any submatrix element is not 0. The following example demonstrates the use of the isDefault function:
Optionally, it is possible to switch between strict semantics (blaze::strict) and relaxed semantics (blaze::relaxed):
|
inline |
Checks if the given submatrix is Hermitian.
sm | The submatrix to be checked. |
This function checks if the given submatrix is Hermitian. The submatrix is considered to be Hermitian if it is a square matrix whose transpose is equal to its conjugate transpose ( ). The following code example demonstrates the use of the function:
|
inlinenoexcept |
Returns whether the invariants of the given submatrix are intact.
sm | The submatrix to be tested. |
This function checks whether the invariants of the submatrix are intact, i.e. if its state is valid. In case the invariants are intact, the function returns true, else it will return false. The following example demonstrates the use of the isIntact() function:
|
inline |
Checks if the given submatrix is a lower triangular matrix.
sm | The submatrix to be checked. |
This function checks if the given submatrix is a lower triangular matrix. The matrix is considered to be lower triangular if it is a square matrix of the form
or
matrices are considered as trivially lower triangular. The following code example demonstrates the use of the function:
|
inlinenoexcept |
Returns whether the given matrix and submatrix represent the same observable state.
a | The submatrix to be tested for its state. |
b | The matrix to be tested for its state. |
This overload of the isSame function tests if the given submatrix refers to the full given matrix and by that represents the same observable state. In this case, the function returns true, otherwise it returns false.
|
inlinenoexcept |
Returns whether the given matrix and submatrix represent the same observable state.
a | The matrix to be tested for its state. |
b | The submatrix to be tested for its state. |
This overload of the isSame function tests if the given submatrix refers to the full given matrix and by that represents the same observable state. In this case, the function returns true, otherwise it returns false.
|
inlinenoexcept |
Returns whether the two given submatrices represent the same observable state.
a | The first submatrix to be tested for its state. |
b | The second submatrix to be tested for its state. |
This overload of the isSame function tests if the two given submatrices refer to exactly the same part of the same matrix. In case both submatrices represent the same observable state, the function returns true, otherwise it returns false.
|
inline |
Checks if the given submatrix is a strictly lower triangular matrix.
sm | The submatrix to be checked. |
This function checks if the given submatrix is a strictly lower triangular matrix. The matrix is considered to be lower triangular if it is a square matrix of the form
The following code example demonstrates the use of the function:
|
inline |
Checks if the given submatrix is a strictly upper triangular matrix.
sm | The submatrix to be checked. |
This function checks if the given sparse submatrix is a strictly upper triangular matrix. The matrix is considered to be upper triangular if it is a square matrix of the form
The following code example demonstrates the use of the function:
|
inline |
Checks if the given submatrix is symmetric.
sm | The submatrix to be checked. |
This function checks if the given submatrix is symmetric. The submatrix is considered to be symmetric if it is a square matrix whose transpose is equal to itself ( ). The following code example demonstrates the use of the function:
|
inline |
Checks if the given submatrix is a lower unitriangular matrix.
sm | The submatrix to be checked. |
This function checks if the given submatrix is a lower unitriangular matrix. The matrix is considered to be lower triangular if it is a square matrix of the form
The following code example demonstrates the use of the function:
|
inline |
Checks if the given submatrix is an upper unitriangular matrix.
sm | The submatrix to be checked. |
This function checks if the given sparse submatrix is an upper triangular matrix. The matrix is considered to be upper triangular if it is a square matrix of the form
The following code example demonstrates the use of the function:
|
inline |
Checks if the given submatrix is an upper triangular matrix.
sm | The submatrix to be checked. |
This function checks if the given sparse submatrix is an upper triangular matrix. The matrix is considered to be upper triangular if it is a square matrix of the form
or
matrices are considered as trivially upper triangular. The following code example demonstrates the use of the function:
|
inline |
Resetting the given submatrix.
sm | The submatrix to be resetted. |
|
inline |
Resetting the given temporary submatrix.
sm | The temporary submatrix to be resetted. |
|
inline |
Reset the specified row/column of the given submatrix.
sm | The submatrix to be resetted. |
i | The index of the row/column to be resetted. |
This function resets the values in the specified row/column of the given submatrix to their default value. In case the given submatrix is a rowMajor matrix the function resets the values in row i, if it is a columnMajor matrix the function resets the values in column i. Note that the capacity of the row/column remains unchanged.