Classes

Classes

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

Column operators

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

Detailed Description

Function Documentation

◆ clear() [1/2]

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

Clearing the given column.

Parameters
columnThe column to be cleared.
Returns
void

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

◆ clear() [2/2]

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

Clearing the given temporary column.

Parameters
columnThe temporary column to be cleared.
Returns
void

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

◆ isDefault()

template<bool RF, typename MT , bool SO, bool DF, bool SF>
bool blaze::isDefault ( const Column< MT, SO, DF, SF > &  column)
inline

Returns whether the given column is in default state.

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

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

// ... Resizing and initialization
if( isDefault( column( A, 0UL ) ) ) { ... }

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

if( isDefault<relaxed>( column( A, 0UL ) ) ) { ... }

◆ isIntact()

template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isIntact ( const Column< MT, SO, DF, SF > &  column)
inlinenoexcept

Returns whether the invariants of the given column are intact.

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

This function checks whether the invariants of the column 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( column( A, 0UL ) ) ) { ... }

◆ isSame()

template<typename MT , bool SO, bool DF, bool SF>
bool blaze::isSame ( const Column< MT, SO, DF, SF > &  a,
const Column< MT, SO, DF, SF > &  b 
)
inlinenoexcept

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

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

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

◆ reset() [1/2]

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

Resetting the given column.

Parameters
columnThe column to be resetted.
Returns
void

◆ reset() [2/2]

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

Resetting the given temporary column.

Parameters
columnThe temporary column to be resetted.
Returns
void