Classes

Classes

class  blaze::UniformMatrix< Type, SO >
 Efficient implementation of a uniform matrix.The UniformMatrix class template is the representation of an arbitrary sized uniform matrix with elements of arbitrary type. The type of the elements and the storage order of the matrix can be specified via the two template parameters: More...
 

UniformMatrix operators

template<typename Type , bool SO>
constexpr void blaze::reset (UniformMatrix< Type, SO > &m)
 Resetting the given uniform matrix. More...
 
template<bool RF, typename Type , bool SO>
constexpr bool blaze::isDefault (const UniformMatrix< Type, SO > &m)
 Returns whether the given uniform matrix is in default state. More...
 
template<typename Type , bool SO>
constexpr bool blaze::isIntact (const UniformMatrix< Type, SO > &m) noexcept
 Returns whether the invariants of the given uniform matrix are intact. More...
 
template<typename Type , bool SO>
constexpr void blaze::swap (UniformMatrix< Type, SO > &a, UniformMatrix< Type, SO > &b) noexcept
 Swapping the contents of two uniform matrices. More...
 
template<typename Type , bool SO>
constexpr void blaze::clear (UniformMatrix< Type, SO > &m)
 Clearing the given dynamic matrix. More...
 

Detailed Description

Function Documentation

◆ clear()

template<typename Type , bool SO>
constexpr void blaze::clear ( UniformMatrix< Type, SO > &  m)
inline

Clearing the given dynamic matrix.

Parameters
mThe matrix to be cleared.
Returns
void

◆ isDefault()

template<bool RF, typename Type , bool SO>
constexpr bool blaze::isDefault ( const UniformMatrix< Type, SO > &  m)
inline

Returns whether the given uniform 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 uniform 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 ) ) { ... }

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 SO>
constexpr bool blaze::isIntact ( const UniformMatrix< Type, SO > &  m)
inlinenoexcept

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

Parameters
mThe uniform 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 uniform 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 ) ) { ... }

◆ reset()

template<typename Type , bool SO>
constexpr void blaze::reset ( UniformMatrix< Type, SO > &  m)
inline

Resetting the given uniform matrix.

Parameters
mThe matrix to be resetted.
Returns
void

◆ swap()

template<typename Type , bool SO>
constexpr void blaze::swap ( UniformMatrix< Type, SO > &  a,
UniformMatrix< Type, SO > &  b 
)
inlinenoexcept

Swapping the contents of two uniform matrices.

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