|
template<typename MT , bool SO, bool DF> |
void | blaze::reset (LowerMatrix< MT, SO, DF > &m) |
| Resetting the given lower matrix. More...
|
|
template<typename MT , bool SO, bool DF> |
void | blaze::reset (LowerMatrix< MT, SO, DF > &m, size_t i) |
| Resetting the specified row/column of the given lower matrix. More...
|
|
template<typename MT , bool SO, bool DF> |
void | blaze::clear (LowerMatrix< MT, SO, DF > &m) |
| Clearing the given lower matrix. More...
|
|
template<bool RF, typename MT , bool SO, bool DF> |
bool | blaze::isDefault (const LowerMatrix< MT, SO, DF > &m) |
| Returns whether the given lower matrix is in default state. More...
|
|
template<typename MT , bool SO, bool DF> |
bool | blaze::isIntact (const LowerMatrix< MT, SO, DF > &m) |
| Returns whether the invariants of the given lower matrix are intact. More...
|
|
template<typename MT , bool SO, bool DF> |
void | blaze::swap (LowerMatrix< MT, SO, DF > &a, LowerMatrix< MT, SO, DF > &b) noexcept |
| Swapping the contents of two matrices. More...
|
|
template<bool RF, typename MT , bool SO, bool DF>
bool blaze::isDefault |
( |
const LowerMatrix< MT, SO, DF > & |
m | ) |
|
|
inline |
Returns whether the given lower matrix is in default state.
- Parameters
-
m | The lower 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:
LowerMatrix< DynamicMatrix<int> > A;
Optionally, it is possible to switch between strict semantics (blaze::strict) and relaxed semantics (blaze::relaxed):
if( isDefault<relaxed>( A ) ) { ... }
template<bool RF, typename MT >
bool blaze::isDefault |
( |
const LowerProxy< MT > & |
proxy | ) |
|
|
inline |
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 blaze::isIntact |
( |
const LowerMatrix< MT, SO, DF > & |
m | ) |
|
|
inline |
Returns whether the invariants of the given lower matrix are intact.
- Parameters
-
m | The lower 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 lower 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:
LowerMatrix< DynamicMatrix<int> > A;
template<typename MT , bool SO, bool DF>
bool blaze::isIntact |
( |
const UpperMatrix< MT, SO, DF > & |
m | ) |
|
|
inline |
Returns whether the invariants of the given lower matrix are intact.
- Parameters
-
m | The lower 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 lower 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:
UpperMatrix< DynamicMatrix<int> > A;
template<bool RF, typename MT >
bool blaze::isOne |
( |
const LowerProxy< MT > & |
proxy | ) |
|
|
inline |
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 >
bool blaze::isReal |
( |
const LowerProxy< MT > & |
proxy | ) |
|
|
inline |
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 >
bool blaze::isZero |
( |
const LowerProxy< MT > & |
proxy | ) |
|
|
inline |
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>
Resetting the specified row/column of the given lower matrix.
- Parameters
-
m | The lower 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 lower 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.