|
class | blaze::SymmetricMatrix< MT, SO, DF, NF > |
| Matrix adapter for symmetric matrices. More...
|
|
class | blaze::NonNumericProxy< MT > |
| Access proxy for symmetric, square matrices with non-numeric element types.The NonNumericProxy provides controlled access to the elements of a non-const symmetric matrix with non-numeric element type (e.g. vectors or matrices). It guarantees that a modification of element of the accessed matrix is also applied to element . The following example illustrates this by means of a sparse symmetric matrix with StaticVector elements: More...
|
|
class | blaze::NumericProxy< MT > |
| Access proxy for symmetric, square matrices with numeric element types.The NumericProxy provides controlled access to the elements of a non-const symmetric matrix with numeric element type (e.g. integral values, floating point values, and complex values). It guarantees that a modification of element of the accessed matrix is also applied to element . The following example illustrates this by means of a dense symmetric matrix: More...
|
|
class | blaze::SharedValue< Type > |
| Value shared among several positions within a symmetric matrix.The SharedValue class template represents a single value of a symmetric matrix that is shared among several positions within the symmetric matrix. Changes to the value of one position are therefore applied to all positions sharing the same value. More...
|
|
class | blaze::SymmetricElement< MT > |
| Representation of two synchronized elements within the sparse symmetric matrix.The SymmetricElement class represents two synchronized elements (i.e. two value/index pairs) within a sparse symmetric matrix. It guarantees that a modification of element via iterator is also applied to element . The following example illustrates this by means of a dense Hermitian matrix: More...
|
|
class | blaze::SymmetricValue< MT > |
| Representation of two synchronized values within a sparse symmetric matrix.The SymmetricValue class represents two synchronized values within a sparse symmetric matrix. It guarantees that a modification of value via iterator is also applied to the value . The following example illustrates this by means of a sparse symmetric matrix: More...
|
|
|
template<typename MT , bool SO, bool DF, bool NF> |
void | blaze::reset (SymmetricMatrix< MT, SO, DF, NF > &m) |
| Resetting the given symmetric matrix. More...
|
|
template<typename MT , bool SO, bool DF, bool NF> |
void | blaze::reset (SymmetricMatrix< MT, SO, DF, NF > &m, size_t i) |
| Resetting the specified row/column of the given symmetric matrix. More...
|
|
template<typename MT , bool SO, bool DF, bool NF> |
void | blaze::clear (SymmetricMatrix< MT, SO, DF, NF > &m) |
| Clearing the given symmetric matrix. More...
|
|
template<bool RF, typename MT , bool SO, bool DF, bool NF> |
bool | blaze::isDefault (const SymmetricMatrix< MT, SO, DF, NF > &m) |
| Returns whether the given symmetric matrix is in default state. More...
|
|
template<typename MT , bool SO, bool DF, bool NF> |
bool | blaze::isIntact (const SymmetricMatrix< MT, SO, DF, NF > &m) |
| Returns whether the invariants of the given symmetric matrix are intact. More...
|
|
template<typename MT , bool SO, bool DF, bool NF> |
void | blaze::swap (SymmetricMatrix< MT, SO, DF, NF > &a, SymmetricMatrix< MT, SO, DF, NF > &b) noexcept |
| Swapping the contents of two matrices. More...
|
|
template<bool RF, typename T1 , typename T2 >
Equality check for a two shared values.
- Parameters
-
a | The left-hand side shared value. |
b | The right-hand side shared value. |
- Returns
- true if the two shared values are equal, false if not.
This function checks whether the two given shared values are equal, taking the limited machine accuracy into account. In case the two values are equal, the function returns true, otherwise it returns false.
template<bool RF, typename MT , bool SO, bool DF, bool NF>
Returns whether the given symmetric matrix is in default state.
- Parameters
-
m | The symmetric matrix to be tested for its default state. |
- Returns
- true in case the given matrix is component-wise zero, false otherwise.
This function checks whether the matrix is in default state. For instance, in case the matrix is instantiated for a built-in integral or floating point data type, the function returns true in case all matrix elements are 0 and false in case any matrix 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):
if( isDefault<relaxed>( A ) ) { ... }
template<bool RF, typename Type >
bool blaze::isDefault |
( |
const SharedValue< Type > & |
value | ) |
|
|
inline |
Returns whether the shared value is in default state.
- Parameters
-
value | The given shared value. |
- Returns
- true in case the shared value is in default state, false otherwise.
This function checks whether the given shared value is in default state. In case it is in default state, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the represented element is in default state.
- Parameters
-
proxy | The given access proxy. |
- Returns
- true in case the represented element is in default state, false otherwise.
This function checks whether the element represented by the access proxy is in default state. In case it is in default state, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the symmetric value is in default state.
- Parameters
-
value | The given symmetric value. |
- Returns
- true in case the symmetric value is in default state, false otherwise.
This function checks whether the symmetric value is in default state. In case it is in default state, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the represented element is in default state.
- Parameters
-
proxy | The given access proxy |
- Returns
- true in case the represented element is in default state, false otherwise.
This function checks whether the element represented by the access proxy is in default state. In case it is in default state, the function returns true, otherwise it returns false.
template<typename MT , bool SO, bool DF, bool NF>
Returns whether the invariants of the given symmetric matrix are intact.
- Parameters
-
m | The symmetric matrix to be tested. |
- Returns
- true in case the given matrix's invariants are intact, false otherwise.
This function checks whether the invariants of the symmetric 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. The following example demonstrates the use of the isIntact() function:
SymmetricMatrix< DynamicMatrix<int> > A;
template<bool RF, typename MT >
Returns whether the represented element is 1.
- Parameters
-
proxy | The given access proxy. |
- Returns
- true in case the represented element is 1, false otherwise.
This function checks whether the element represented by the access proxy represents the numeric value 1. In case it is 1, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the symmetric value is 1.
- Parameters
-
value | The given symmetric value. |
- Returns
- true in case the symmetric value is 1, false otherwise.
This function checks whether the symmetric value represents the numeric value 1. In case it is 1, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the represented element is 1.
- Parameters
-
proxy | The given access proxy. |
- Returns
- true in case the represented element is 1, false otherwise.
This function checks whether the element represented by the access proxy represents the numeric value 1. In case it is 1, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the matrix element represents a real number.
- Parameters
-
proxy | The given access proxy. |
- Returns
- true in case the matrix element represents a real number, false otherwise.
This function checks whether the element represented by the access proxy represents the a real number. In case the element is of built-in type, the function returns true. In case the element is of complex type, the function returns true if the imaginary part is equal to 0. Otherwise it returns false.
template<bool RF, typename MT >
Returns whether the symmetric value represents a real number.
- Parameters
-
value | The given symmetric value. |
- Returns
- true in case the symmetric value represents a real number, false otherwise.
This function checks whether the symmetric value represents the a real number. In case the value is of built-in type, the function returns true. In case the element is of complex type, the function returns true if the imaginary part is equal to 0. Otherwise it returns false.
template<bool RF, typename MT >
Returns whether the matrix element represents a real number.
- Parameters
-
proxy | The given access proxy. |
- Returns
- true in case the matrix element represents a real number, false otherwise.
This function checks whether the element represented by the access proxy represents the a real number. In case the element is of built-in type, the function returns true. In case the element is of complex type, the function returns true if the imaginary part is equal to 0. Otherwise it returns false.
template<bool RF, typename MT >
Returns whether the represented element is 0.
- Parameters
-
proxy | The given access proxy. |
- Returns
- true in case the represented element is 0, false otherwise.
This function checks whether the element represented by the access proxy represents the numeric value 0. In case it is 0, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the symmetric value is 0.
- Parameters
-
value | The given symmetric value. |
- Returns
- true in case the symmetric value is 0, false otherwise.
This function checks whether the symmetric value represents the numeric value 0. In case it is 0, the function returns true, otherwise it returns false.
template<bool RF, typename MT >
Returns whether the represented element is 0.
- Parameters
-
proxy | The given access proxy. |
- Returns
- true in case the represented element is 0, false otherwise.
This function checks whether the element represented by the access proxy represents the numeric value 0. In case it is 0, the function returns true, otherwise it returns false.
template<typename MT , bool SO, bool DF, bool NF>
Resetting the specified row/column of the given symmetric matrix.
- Parameters
-
m | The symmetric matrix to be resetted. |
i | The index of the row/column to be resetted. |
- Returns
- void
This function resets the values in the specified row/column of the given symmetric matrix to their default value. In case the given matrix 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.