Blaze 3.9
Classes

Classes

class  blaze::DynamicMatrix< Type, SO, Alloc, Tag >
 Efficient implementation of a dynamic $ M \times N $ matrix. More...
 

DynamicMatrix operators

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

StaticMatrix operators

template<RelaxationFlag RF, typename Type , size_t M, size_t N, bool SO, AlignmentFlag AF, PaddingFlag PF, typename Tag >
bool blaze::isDefault (const StaticMatrix< Type, M, N, SO, AF, PF, Tag > &m)
 Returns whether the given dynamic matrix is in default state. More...
 
template<typename Type , size_t M, size_t N, bool SO, AlignmentFlag AF, PaddingFlag PF, typename Tag >
bool blaze::isIntact (const StaticMatrix< Type, M, N, SO, AF, PF, Tag > &m) noexcept
 Returns whether the invariants of the given static matrix are intact. More...
 
template<typename Type , size_t M, size_t N, bool SO, AlignmentFlag AF, PaddingFlag PF, typename Tag >
void blaze::swap (StaticMatrix< Type, M, N, SO, AF, PF, Tag > &a, StaticMatrix< Type, M, N, SO, AF, PF, Tag > &b) noexcept
 Swapping the contents of two static matrices. More...
 

Detailed Description

Function Documentation

◆ isDefault() [1/2]

template<RelaxationFlag RF, typename Type , bool SO, typename Alloc , typename Tag >
bool blaze::isDefault ( const DynamicMatrix< Type, SO, Alloc, Tag > &  m)
inline

Returns whether the given dynamic matrix is in default state.

Parameters
mThe matrix to be tested for its default state.
Returns
true in case the given matrix's rows and columns are zero, false otherwise.

This function checks whether the dynamic matrix is in default (constructed) state, i.e. if it's number of rows and columns 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 a dynamic matrix.
Definition: DynamicMatrix.h:242
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 ) ) { ... }

◆ isDefault() [2/2]

template<RelaxationFlag RF, typename Type , size_t M, size_t N, bool SO, AlignmentFlag AF, PaddingFlag PF, typename Tag >
bool blaze::isDefault ( const StaticMatrix< Type, M, N, SO, AF, PF, Tag > &  m)
inline

Returns whether the given dynamic matrix is in default state.

Parameters
mThe matrix to be tested for its default state.
Returns
true in case the given matrix's rows and columns are zero, false otherwise.

This function checks whether the static matrix is in default (constructed) state. 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:

// ... Initialization
if( isDefault( A ) ) { ... }
Efficient implementation of a fixed-sized matrix.
Definition: StaticMatrix.h:249

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

if( isDefault<relaxed>( A ) ) { ... }

◆ isIntact() [1/2]

template<typename Type , bool SO, typename Alloc , typename Tag >
bool blaze::isIntact ( const DynamicMatrix< Type, SO, Alloc, Tag > &  m)
inlinenoexcept

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

Parameters
mThe dynamic matrix to be tested.
Returns
true in case the given matrix's invariants are intact, false otherwise.

This function checks whether the invariants of the dynamic matrix 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

◆ isIntact() [2/2]

template<typename Type , size_t M, size_t N, bool SO, AlignmentFlag AF, PaddingFlag PF, typename Tag >
bool blaze::isIntact ( const StaticMatrix< Type, M, N, SO, AF, PF, Tag > &  m)
inlinenoexcept

Returns whether the invariants of the given static matrix are intact.

Parameters
mThe static matrix to be tested.
Returns
true in case the given matrix's invariants are intact, false otherwise.

This function checks whether the invariants of the static matrix 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:

// ... Initialization
if( isIntact( A ) ) { ... }

◆ swap() [1/2]

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

Swapping the contents of two dynamic matrices.

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

◆ swap() [2/2]

template<typename Type , size_t M, size_t N, bool SO, AlignmentFlag AF, PaddingFlag PF, typename Tag >
void blaze::swap ( StaticMatrix< Type, M, N, SO, AF, PF, Tag > &  a,
StaticMatrix< Type, M, N, SO, AF, PF, Tag > &  b 
)
inlinenoexcept

Swapping the contents of two static matrices.

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