All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes
Dense Submatrix

Classes

class  blaze::DenseSubmatrix< MT, AF, SO >
 View on a specific submatrix of a dense matrix.The DenseSubmatrix template represents a view on a specific submatrix of a dense matrix primitive. The type of the dense matrix is specified via the first template parameter: More...
 

DenseSubmatrix operators

template<typename MT , bool AF, bool SO>
void blaze::reset (DenseSubmatrix< MT, AF, SO > &dm)
 Resetting the given dense submatrix. More...
 
template<typename MT , bool AF, bool SO>
void blaze::clear (DenseSubmatrix< MT, AF, SO > &dm)
 Clearing the given dense matrix. More...
 
template<typename MT , bool AF, bool SO>
bool blaze::isDefault (const DenseSubmatrix< MT, AF, SO > &dm)
 Returns whether the given dense submatrix is in default state. More...
 
template<typename MT , bool AF, bool SO>
bool blaze::isSame (const DenseSubmatrix< MT, AF, SO > &a, const DenseMatrix< MT, SO > &b)
 Returns whether the given dense matrix and submatrix represent the same observable state. More...
 
template<typename MT , bool AF, bool SO>
bool blaze::isSame (const DenseMatrix< MT, SO > &a, const DenseSubmatrix< MT, AF, SO > &b)
 Returns whether the given dense matrix and submatrix represent the same observable state. More...
 
template<typename MT , bool AF, bool SO>
bool blaze::isSame (const DenseSubmatrix< MT, AF, SO > &a, const DenseSubmatrix< MT, AF, SO > &b)
 Returns whether the two given submatrices represent the same observable state. More...
 

Detailed Description

Function Documentation

template<typename MT , bool AF, bool SO>
void blaze::clear ( DenseSubmatrix< MT, AF, SO > &  dm)
inline

Clearing the given dense matrix.

Parameters
dmThe dense matrix to be cleared.
Returns
void

Clearing a dense submatrix is equivalent to resetting it via the reset() function.

template<typename MT , bool AF, bool SO>
bool blaze::isDefault ( const DenseSubmatrix< MT, AF, SO > &  dm)
inline

Returns whether the given dense submatrix is in default state.

Parameters
dmThe dense submatrix to be tested for its default state.
Returns
true in case the given submatrix is component-wise zero, false otherwise.

This function checks whether the submatrix is in default state. For instance, in case the submatrix is instantiated for a built-in integral or floating point data type, the function returns true in case all submatrix elements are 0 and false in case any submatrix element is not 0. The following example demonstrates the use of the isDefault function:

// ... Resizing and initialization
if( isDefault( submatrix( A, 12UL, 13UL, 22UL, 33UL ) ) ) { ... }
template<typename MT , bool AF, bool SO>
bool blaze::isSame ( const DenseSubmatrix< MT, AF, SO > &  a,
const DenseMatrix< MT, SO > &  b 
)
inline

Returns whether the given dense matrix and submatrix represent the same observable state.

Parameters
aThe dense submatrix to be tested for its state.
bThe dense matrix to be tested for its state.
Returns
true in case the dense submatrix and matrix share a state, false otherwise.

This overload of the isSame function tests if the given submatrix refers to the full given dense matrix and by that represents the same observable state. In this case, the function returns true, otherwise it returns false.

template<typename MT , bool AF, bool SO>
bool blaze::isSame ( const DenseMatrix< MT, SO > &  a,
const DenseSubmatrix< MT, AF, SO > &  b 
)
inline

Returns whether the given dense matrix and submatrix represent the same observable state.

Parameters
aThe dense matrix to be tested for its state.
bThe dense submatrix to be tested for its state.
Returns
true in case the dense matrix and submatrix share a state, false otherwise.

This overload of the isSame function tests if the given submatrix refers to the full given dense matrix and by that represents the same observable state. In this case, the function returns true, otherwise it returns false.

template<typename MT , bool AF, bool SO>
bool blaze::isSame ( const DenseSubmatrix< MT, AF, SO > &  a,
const DenseSubmatrix< MT, AF, SO > &  b 
)
inline

Returns whether the two given submatrices represent the same observable state.

Parameters
aThe first dense submatrix to be tested for its state.
bThe second dense submatrix to be tested for its state.
Returns
true in case the two submatrices share a state, false otherwise.

This overload of the isSame function tests if the two given submatrices refer to exactly the same part of the same dense matrix. In case both submatrices represent the same observable state, the function returns true, otherwise it returns false.

template<typename MT , bool AF, bool SO>
void blaze::reset ( DenseSubmatrix< MT, AF, SO > &  dm)
inline

Resetting the given dense submatrix.

Parameters
dmThe dense submatrix to be resetted.
Returns
void