Blaze 3.9
Classes
CompressedMatrix

Classes

class  blaze::CompressedMatrix< Type, SO, Tag >
 Efficient implementation of a $ M \times N $ compressed matrix. More...
 

CompressedMatrix operators

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

Detailed Description

Function Documentation

◆ isDefault()

template<RelaxationFlag RF, typename Type , bool SO, typename Tag >
bool blaze::isDefault ( const CompressedMatrix< Type, SO, Tag > &  m)
inline

Returns whether the given compressed matrix is in default state.

Parameters
mThe matrix to be tested for its default state.
Returns
true in case the given matrix's rows and columns are zero, false otherwise.

This function checks whether the compressed matrix is in default (constructed) state, i.e. if it's number of rows and columns is 0. In case it is in default state, the function returns true, else it will return false. The following example demonstrates the use of the isDefault() function:

// ... Resizing and initialization
if( isDefault( A ) ) { ... }
Efficient implementation of a compressed matrix.
Definition: CompressedMatrix.h:239
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 Type , bool SO, typename Tag >
bool blaze::isIntact ( const CompressedMatrix< Type, SO, Tag > &  m)
inline

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

Parameters
mThe compressed 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 compressed 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 Type , bool SO, typename Tag >
void blaze::swap ( CompressedMatrix< Type, SO, Tag > &  a,
CompressedMatrix< Type, SO, Tag > &  b 
)
inlinenoexcept

Swapping the contents of two compressed matrices.

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