Blaze 3.9
Classes
DynamicVector

Classes

class  blaze::DynamicVector< Type, TF, Alloc, Tag >
 Efficient implementation of an arbitrary sized vector. More...
 

DynamicVector operators

template<RelaxationFlag RF, typename Type , bool TF, typename Alloc , typename Tag >
bool blaze::isDefault (const DynamicVector< Type, TF, Alloc, Tag > &v)
 Returns whether the given dynamic vector is in default state. More...
 
template<typename Type , bool TF, typename Alloc , typename Tag >
bool blaze::isIntact (const DynamicVector< Type, TF, Alloc, Tag > &v) noexcept
 Returns whether the invariants of the given dynamic vector are intact. More...
 
template<typename Type , bool TF, typename Alloc , typename Tag >
void blaze::swap (DynamicVector< Type, TF, Alloc, Tag > &a, DynamicVector< Type, TF, Alloc, Tag > &b) noexcept
 Swapping the contents of two vectors. More...
 

Detailed Description

Function Documentation

◆ isDefault()

template<RelaxationFlag RF, typename Type , bool TF, typename Alloc , typename Tag >
bool blaze::isDefault ( const DynamicVector< Type, TF, Alloc, Tag > &  v)
inline

Returns whether the given dynamic vector is in default state.

Parameters
vThe dynamic 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 dynamic 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 ) ) { ... }
Efficient implementation of an arbitrary sized vector.
Definition: DynamicVector.h:223
bool isDefault(const DiagonalMatrix< MT, SO, DF > &m)
Returns whether the given diagonal matrix is in default state.
Definition: DiagonalMatrix.h:169

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, typename Alloc , typename Tag >
bool blaze::isIntact ( const DynamicVector< Type, TF, Alloc, Tag > &  v)
inlinenoexcept

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

Parameters
vThe dynamic 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 dynamic 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 ) ) { ... }
bool isIntact(const DiagonalMatrix< MT, SO, DF > &m)
Returns whether the invariants of the given diagonal matrix are intact.
Definition: DiagonalMatrix.h:207

◆ swap()

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

Swapping the contents of two vectors.

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