Blaze  3.6
Classes

Classes

class  blaze::HybridMatrix< Type, M, N, SO >
 Efficient implementation of a dynamically sized matrix with static memory.The HybridMatrix class template combines the flexibility of a dynamically sized matrix with the efficiency and performance of a fixed-size matrix. It is implemented as a crossing between the blaze::StaticMatrix and the blaze::DynamicMatrix class templates: Similar to the static matrix it uses static stack memory instead of dynamically allocated memory and similar to the dynamic matrix it can be resized (within the extend of the static memory). The type of the elements, the maximum number of rows and columns and the storage order of the matrix can be specified via the four template parameters: More...
 

HybridMatrix operators

template<typename Type , size_t M, size_t N, bool SO>
void blaze::reset (HybridMatrix< Type, M, N, SO > &m)
 Resetting the given hybrid matrix. More...
 
template<typename Type , size_t M, size_t N, bool SO>
void blaze::reset (HybridMatrix< Type, M, N, SO > &m, size_t i)
 Reset the specified row/column of the given hybrid matrix. More...
 
template<typename Type , size_t M, size_t N, bool SO>
void blaze::clear (HybridMatrix< Type, M, N, SO > &m)
 Clearing the given hybrid matrix. More...
 
template<bool RF, typename Type , size_t M, size_t N, bool SO>
bool blaze::isDefault (const HybridMatrix< Type, M, N, SO > &m)
 Returns whether the given hybrid matrix is in default state. More...
 
template<typename Type , size_t M, size_t N, bool SO>
bool blaze::isIntact (const HybridMatrix< Type, M, N, SO > &m) noexcept
 Returns whether the invariants of the given hybrid matrix are intact. More...
 
template<typename Type , size_t M, size_t N, bool SO>
void blaze::swap (HybridMatrix< Type, M, N, SO > &a, HybridMatrix< Type, M, N, SO > &b) noexcept
 Swapping the contents of two hybrid matrices. More...
 

Detailed Description

Function Documentation

◆ clear()

template<typename Type , size_t M, size_t N, bool SO>
void blaze::clear ( HybridMatrix< Type, M, N, SO > &  m)
inline

Clearing the given hybrid matrix.

Parameters
mThe matrix to be cleared.
Returns
void

◆ isDefault()

template<bool RF, typename Type , size_t M, size_t N, bool SO>
bool blaze::isDefault ( const HybridMatrix< Type, M, N, SO > &  m)
inline

Returns whether the given hybrid matrix is in default state.

Parameters
mThe hybrid 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 hybrid 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 , size_t M, size_t N, bool SO>
bool blaze::isIntact ( const HybridMatrix< Type, M, N, SO > &  m)
inlinenoexcept

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

Parameters
mThe hybrid 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 hybrid 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() [1/2]

template<typename Type , size_t M, size_t N, bool SO>
void blaze::reset ( HybridMatrix< Type, M, N, SO > &  m)
inline

Resetting the given hybrid matrix.

Parameters
mThe matrix to be resetted.
Returns
void

◆ reset() [2/2]

template<typename Type , size_t M, size_t N, bool SO>
void blaze::reset ( HybridMatrix< Type, M, N, SO > &  m,
size_t  i 
)
inline

Reset the specified row/column of the given hybrid matrix.

Parameters
mThe matrix to be resetted.
iThe index of the row/column to be resetted.
Returns
void

This function resets the values in the specified row/column of the given hybrid matrix to their default value. In case the given matrix is a rowMajor matrix the function resets the values in row i, if it is a columnMajor matrix the function resets the values in column i. Note that the capacity of the row/column remains unchanged.

◆ swap()

template<typename Type , size_t M, size_t N, bool SO>
void blaze::swap ( HybridMatrix< Type, M, N, SO > &  a,
HybridMatrix< Type, M, N, SO > &  b 
)
inlinenoexcept

Swapping the contents of two hybrid matrices.

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