Blaze  3.6
Classes
CompressedVector

Classes

class  blaze::CompressedVector< Type, TF >
 Efficient implementation of an arbitrary sized sparse vector.The CompressedVector class is the representation of an arbitrarily sized sparse vector, which stores only non-zero elements of arbitrary type. The type of the elements and the transpose flag of the vector can be specified via the two template parameters: More...
 

CompressedVector operators

template<typename Type , bool TF>
void blaze::reset (CompressedVector< Type, TF > &v)
 Resetting the given compressed vector. More...
 
template<typename Type , bool TF>
void blaze::clear (CompressedVector< Type, TF > &v)
 Clearing the given compressed vector. More...
 
template<bool RF, typename Type , bool TF>
bool blaze::isDefault (const CompressedVector< Type, TF > &v)
 Returns whether the given compressed vector is in default state. More...
 
template<typename Type , bool TF>
bool blaze::isIntact (const CompressedVector< Type, TF > &v) noexcept
 Returns whether the invariants of the given compressed vector are intact. More...
 
template<typename Type , bool TF>
void blaze::swap (CompressedVector< Type, TF > &a, CompressedVector< Type, TF > &b) noexcept
 Swapping the contents of two compressed vectors. More...
 

Detailed Description

Function Documentation

◆ clear()

template<typename Type , bool TF>
void blaze::clear ( CompressedVector< Type, TF > &  v)
inline

Clearing the given compressed vector.

Parameters
vThe compressed vector to be cleared.
Returns
void

◆ isDefault()

template<bool RF, typename Type , bool TF>
bool blaze::isDefault ( const CompressedVector< Type, TF > &  v)
inline

Returns whether the given compressed vector is in default state.

Parameters
vThe compressed vector to be tested for its default state.
Returns
true in case the given vector's size is zero, false otherwise.

This function checks whether the compressed vector is in default (constructed) state, i.e. if it's size 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 TF>
bool blaze::isIntact ( const CompressedVector< Type, TF > &  v)
inlinenoexcept

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

Parameters
vThe compressed vector to be tested.
Returns
true in case the given vector's invariants are intact, false otherwise.

This function checks whether the invariants of the compressed vector 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()

template<typename Type , bool TF>
void blaze::reset ( CompressedVector< Type, TF > &  v)
inline

Resetting the given compressed vector.

Parameters
vThe compressed vector to be resetted.
Returns
void

◆ swap()

template<typename Type , bool TF>
void blaze::swap ( CompressedVector< Type, TF > &  a,
CompressedVector< Type, TF > &  b 
)
inlinenoexcept

Swapping the contents of two compressed vectors.

Parameters
aThe first compressed vector to be swapped.
bThe second compressed vector to be swapped.
Returns
void