Classes

Classes

class  blaze::Row< MT, SO, DF, SF >
 Reference to a specific row of a dense or sparse matrix.The Row template represents a reference to a specific row of a dense or sparse matrix primitive. The type of the matrix is specified via the first template parameter: More...
 

Row operators

template<typename MT , bool SO, bool DF, bool SF>
void blaze::reset (Row< MT, SO, DF, SF > &row)
 Resetting the given row. More...
 
template<typename MT , bool SO, bool DF, bool SF>
void blaze::clear (Row< MT, SO, DF, SF > &row)
 Clearing the given row. More...
 
template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isDefault (const Row< MT, SO, DF, SF > &row)
 Returns whether the given row is in default state. More...
 
template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isIntact (const Row< MT, SO, DF, SF > &row) noexcept
 Returns whether the invariants of the given row are intact. More...
 
template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isSame (const Row< MT, SO, DF, SF > &a, const Row< MT, SO, DF, SF > &b) noexcept
 Returns whether the two given rows represent the same observable state. More...
 

Detailed Description

Function Documentation

template<typename MT , bool SO, bool DF, bool SF>
void blaze::clear ( Row< MT, SO, DF, SF > &  row)
inline

Clearing the given row.

Parameters
rowThe row to be cleared.
Returns
void

Clearing a row is equivalent to resetting it via the reset() function.

template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isDefault ( const Row< MT, SO, DF, SF > &  row)
inline

Returns whether the given row is in default state.

Parameters
rowThe row to be tested for its default state.
Returns
true in case the given row is component-wise zero, false otherwise.

This function checks whether the row is in default state. For instance, in case the row is instantiated for a built-in integral or floating point data type, the function returns true in case all row elements are 0 and false in case any row element is not 0. The following example demonstrates the use of the isDefault function:

// ... Resizing and initialization
if( isDefault( row( A, 0UL ) ) ) { ... }
template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isIntact ( const Row< MT, SO, DF, SF > &  row)
inlinenoexcept

Returns whether the invariants of the given row are intact.

Parameters
rowThe row to be tested.
Returns
true in case the given row's invariants are intact, false otherwise.

This function checks whether the invariants of the row 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( row( A, 0UL ) ) ) { ... }
template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isSame ( const Row< MT, SO, DF, SF > &  a,
const Row< MT, SO, DF, SF > &  b 
)
inlinenoexcept

Returns whether the two given rows represent the same observable state.

Parameters
aThe first row to be tested for its state.
bThe second row to be tested for its state.
Returns
true in case the two rows share a state, false otherwise.

This overload of the isSame function tests if the two given rows refer to exactly the same range of the same matrix. In case both rows represent the same observable state, the function returns true, otherwise it returns false.

template<typename MT , bool SO, bool DF, bool SF>
void blaze::reset ( Row< MT, SO, DF, SF > &  row)
inline

Resetting the given row.

Parameters
rowThe row to be resetted.
Returns
void