Blaze 3.9
Classes
DiagonalMatrix

Classes

class  blaze::DiagonalMatrix< MT, SO, DF >
 Matrix adapter for diagonal $ N \times N $ matrices. More...
 
class  blaze::DiagonalProxy< MT >
 Access proxy for diagonal matrices. More...
 

DiagonalMatrix operators

template<RelaxationFlag RF, typename MT , bool SO, bool DF>
bool blaze::isDefault (const DiagonalMatrix< MT, SO, DF > &m)
 Returns whether the given diagonal matrix is in default state. More...
 
template<typename MT , bool SO, bool DF>
bool blaze::isIntact (const DiagonalMatrix< MT, SO, DF > &m)
 Returns whether the invariants of the given diagonal matrix are intact. More...
 
template<typename MT , bool SO, bool DF>
void blaze::swap (DiagonalMatrix< MT, SO, DF > &a, DiagonalMatrix< MT, SO, DF > &b) noexcept
 Swapping the contents of two matrices. More...
 

Detailed Description

Function Documentation

◆ isDefault()

template<RelaxationFlag RF, typename MT , bool SO, bool DF>
bool blaze::isDefault ( const DiagonalMatrix< MT, SO, DF > &  m)
inline

Returns whether the given diagonal matrix is in default state.

Parameters
mThe diagonal 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:

// ... Resizing and initialization
if( isDefault( A ) ) { ... }
Matrix adapter for diagonal matrices.
Definition: BaseTemplate.h:565
Efficient implementation of a dynamic matrix.
Definition: DynamicMatrix.h:242
bool isDefault(const DiagonalMatrix< MT, SO, DF > &m)
Returns whether the given diagonal matrix is in default state.
Definition: DiagonalMatrix.h:169

Optionally, it is possible to switch between strict semantics (blaze::strict) and relaxed semantics (blaze::relaxed):

if( isDefault<relaxed>( A ) ) { ... }

◆ isIntact()

template<typename MT , bool SO, bool DF>
bool blaze::isIntact ( const DiagonalMatrix< MT, SO, DF > &  m)
inline

Returns whether the invariants of the given diagonal matrix are intact.

Parameters
mThe diagonal 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 diagonal 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:

// ... Resizing and initialization
if( isIntact( A ) ) { ... }
bool isIntact(const DiagonalMatrix< MT, SO, DF > &m)
Returns whether the invariants of the given diagonal matrix are intact.
Definition: DiagonalMatrix.h:207

◆ swap()

template<typename MT , bool SO, bool DF>
void blaze::swap ( DiagonalMatrix< MT, SO, DF > &  a,
DiagonalMatrix< MT, SO, DF > &  b 
)
inlinenoexcept

Swapping the contents of two matrices.

Parameters
aThe first matrix to be swapped.
bThe second matrix to be swapped.
Returns
void