Classes
CompressedMatrix

Classes

class  blaze::CompressedMatrix< Type, SO >
 Efficient implementation of a $ M \times N $ compressed matrix.The CompressedMatrix class template is the representation of an arbitrary sized sparse matrix with $ M \cdot N $ dynamically allocated elements of arbitrary type. The type of the elements and the storage order of the matrix can be specified via the two template parameters: More...
 

CompressedMatrix operators

template<typename Type , bool SO>
void reset (CompressedMatrix< Type, SO > &m)
 Resetting the given compressed matrix. More...
 
template<typename Type , bool SO>
void reset (CompressedMatrix< Type, SO > &m, size_t i)
 Reset the specified row/column of the given compressed matrix. More...
 
template<typename Type , bool SO>
void clear (CompressedMatrix< Type, SO > &m)
 Clearing the given compressed matrix. More...
 
template<bool RF, typename Type , bool SO>
bool isDefault (const CompressedMatrix< Type, SO > &m)
 Returns whether the given compressed matrix is in default state. More...
 
template<typename Type , bool SO>
bool isIntact (const CompressedMatrix< Type, SO > &m)
 Returns whether the invariants of the given compressed matrix are intact. More...
 
template<typename Type , bool SO>
void swap (CompressedMatrix< Type, SO > &a, CompressedMatrix< Type, SO > &b) noexcept
 Swapping the contents of two compressed matrices. More...
 

Detailed Description

Function Documentation

◆ clear()

template<typename Type , bool SO>
void clear ( CompressedMatrix< Type, SO > &  m)
inline

Clearing the given compressed matrix.

Parameters
mThe matrix to be cleared.
Returns
void

◆ isDefault()

template<bool RF, typename Type , bool SO>
bool isDefault ( const CompressedMatrix< Type, SO > &  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 ) ) { ... }

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>
bool isIntact ( const CompressedMatrix< Type, SO > &  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 ) ) { ... }

◆ reset() [1/2]

template<typename Type , bool SO>
void reset ( CompressedMatrix< Type, SO > &  m)
inline

Resetting the given compressed matrix.

Parameters
mThe matrix to be resetted.
Returns
void

◆ reset() [2/2]

template<typename Type , bool SO>
void reset ( CompressedMatrix< Type, SO > &  m,
size_t  i 
)
inline

Reset the specified row/column of the given compressed matrix.

Parameters
mThe matrix to be resetted.
iThe index of the row/column to be resetted.
Returns
void

This function resets the values in the specified row/column of the given compressed 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.

◆ swap()

template<typename Type , bool SO>
void swap ( CompressedMatrix< Type, SO > &  a,
CompressedMatrix< Type, SO > &  b 
)
inlinenoexcept

Swapping the contents of two compressed matrices.

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