All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Typedefs
DynamicMatrix

Classes

class  blaze::DynamicMatrix< Type, SO >
 Efficient implementation of a dynamic $ M \times N $ matrix.The DynamicMatrix class template is the representation of an arbitrary sized matrix with $ M \cdot N $ dynamically allocated 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...
 

Typedefs

typedef DynamicMatrix< float,
false > 
blaze::MatMxNf
 MxN single precision matrix.
 
typedef DynamicMatrix< double,
false > 
blaze::MatMxNd
 MxN double precision matrix.
 
typedef DynamicMatrix< real,
false > 
blaze::MatMxN
 MxN matrix with system-specific precision.
 

DynamicMatrix operators

template<typename Type , bool SO>
bool blaze::isnan (const DynamicMatrix< Type, SO > &m)
 Checks the given matrix for not-a-number elements.
 
template<typename Type , bool SO>
void blaze::reset (DynamicMatrix< Type, SO > &m)
 Resetting the given dense matrix.
 
template<typename Type , bool SO>
void blaze::clear (DynamicMatrix< Type, SO > &m)
 Clearing the given dense matrix.
 
template<typename Type , bool SO>
bool blaze::isDefault (const DynamicMatrix< Type, SO > &m)
 Returns whether the given dense matrix is in default state.
 
template<typename Type , bool SO>
const DynamicMatrix< Type, SO > blaze::inv (const DynamicMatrix< Type, SO > &m)
 Inverting the given dense matrix.
 
template<typename Type , bool SO>
void blaze::swap (DynamicMatrix< Type, SO > &a, DynamicMatrix< Type, SO > &b)
 Swapping the contents of two matrices.
 

Detailed Description

Function Documentation

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

Clearing the given dense matrix.

Parameters
mThe dense matrix to be cleared.
Returns
void
template<typename Type , bool SO>
const DynamicMatrix< Type, SO > blaze::inv ( const DynamicMatrix< Type, SO > &  m)
inline

Inverting the given dense matrix.

Parameters
mThe dense matrix to be inverted.
Returns
The inverse of the matrix.

This function returns the inverse of the given dense matrix.

// ... Resizing and initialization
R1 = inv( R2 );

Note: This function is only defined for matrices of floating point type. The attempt to use this function with matrices of integral data types will result in a compile time error.

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

Returns whether the given dense matrix is in default state.

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

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

// ... Resizing and initialization
if( isDefault( A ) ) { ... }
template<typename Type , bool SO>
bool blaze::isnan ( const DynamicMatrix< Type, SO > &  m)
inline

Checks the given matrix for not-a-number elements.

Parameters
mThe matrix to be checked for not-a-number elements.
Returns
true if at least one element of the matrix is not-a-number, false otherwise.
template<typename Type , bool SO>
void blaze::reset ( DynamicMatrix< Type, SO > &  m)
inline

Resetting the given dense matrix.

Parameters
mThe dense matrix to be resetted.
Returns
void
template<typename Type , bool SO>
void blaze::swap ( DynamicMatrix< Type, SO > &  a,
DynamicMatrix< Type, SO > &  b 
)
inline

Swapping the contents of two matrices.

Parameters
aThe first matrix to be swapped.
bThe second matrix to be swapped.
Returns
void
Exceptions
no-throwguarantee.