All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes
SparseColumn

Classes

class  blaze::SparseColumn< typename, bool, bool >
 Reference to a specific column of a sparse matrix.The SparseColumn template represents a reference to a specific column of a sparse matrix primitive. The type of the sparse matrix is specified via the first template parameter: More...
 

SparseColumn operators

template<typename MT , bool SO, bool SF>
void blaze::reset (SparseColumn< MT, SO, SF > &column)
 Resetting the given sparse column. More...
 
template<typename MT , bool SO, bool SF>
void blaze::clear (SparseColumn< MT, SO, SF > &column)
 Clearing the given sparse column. More...
 
template<typename MT , bool SO, bool SF>
bool blaze::isDefault (const SparseColumn< MT, SO, SF > &column)
 Returns whether the given sparse column is in default state. More...
 
template<typename MT , bool SO, bool SF>
bool blaze::isSame (const SparseColumn< MT, SO, SF > &a, const SparseColumn< MT, SO, SF > &b)
 Returns whether the two given sparse columns represent the same observable state. More...
 

Detailed Description

Function Documentation

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

Clearing the given sparse column.

Parameters
columnThe sparse column to be cleared.
Returns
void

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

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

Returns whether the given sparse column is in default state.

Parameters
columnThe sparse 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 sparse 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 vector element is not 0. The following example demonstrates the use of the isDefault function:

// ... Resizing and initialization
if( isDefault( column( A, 0UL ) ) ) { ... }
template<typename MT , bool SO, bool SF>
bool blaze::isSame ( const SparseColumn< MT, SO, SF > &  a,
const SparseColumn< MT, SO, SF > &  b 
)
inline

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

Parameters
aThe first sparse column to be tested for its state.
bThe second sparse 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 sparse columns refer to exactly the same range of the same sparse matrix. In case both columns represent the same observable state, the function returns true, otherwise it returns false.

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

Resetting the given sparse column.

Parameters
columnThe sparse column to be resetted.
Returns
void