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

Modules

 Dense Matrices
 
 Sparse Matrices
 

Classes

struct  blaze::Matrix< MT, SO >
 Base class for matrices.The Matrix class is a base class for all dense and sparse matrix classes within the Blaze library. It provides an abstraction from the actual type of the matrix, but enables a conversion back to this type via the 'Curiously Recurring Template Pattern' (CRTP). More...
 

Matrix global functions

template<typename MT , bool SO>
size_t blaze::rows (const Matrix< MT, SO > &m)
 Returns the current number of rows of the matrix.
 
template<typename MT , bool SO>
size_t blaze::columns (const Matrix< MT, SO > &m)
 Returns the current number of columns of the matrix.
 
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::assign (Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
 Default implementation of the assignment of a matrix to a matrix.
 
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::addAssign (Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
 Default implementation of the addition assignment of a matrix to a matrix.
 
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::subAssign (Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
 Default implementation of the subtraction assignment of a matrix to matrix.
 
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::multAssign (Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
 Default implementation of the multiplication assignment of a matrix to a matrix.
 

Matrix operators

template<typename MT , bool SO>
std::ostream & blaze::operator<< (std::ostream &os, const Matrix< MT, SO > &m)
 Global output operator for dense and sparse matrices.
 

Detailed Description

Function Documentation

template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::addAssign ( Matrix< MT1, SO1 > &  lhs,
const Matrix< MT2, SO2 > &  rhs 
)
inline

Default implementation of the addition assignment of a matrix to a matrix.

Parameters
lhsThe target left-hand side matrix.
rhsThe right-hand side matrix to be added.
Returns
void

This function implements the default addition assignment of a matrix to a matrix.
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.

template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::assign ( Matrix< MT1, SO1 > &  lhs,
const Matrix< MT2, SO2 > &  rhs 
)
inline

Default implementation of the assignment of a matrix to a matrix.

Parameters
lhsThe target left-hand side matrix.
rhsThe right-hand side matrix to be assigned.
Returns
void

This function implements the default assignment of a matrix to a matrix.
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.

template<typename MT , bool SO>
size_t blaze::columns ( const Matrix< MT, SO > &  m)
inline

Returns the current number of columns of the matrix.

Parameters
mThe given matrix.
Returns
The number of columns of the matrix.
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::multAssign ( Matrix< MT1, SO1 > &  lhs,
const Matrix< MT2, SO2 > &  rhs 
)
inline

Default implementation of the multiplication assignment of a matrix to a matrix.

Parameters
lhsThe target left-hand side matrix.
rhsThe right-hand side matrix to be multiplied.
Returns
void

This function implements the default multiplication assignment of a matrix to a matrix.
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.

template<typename MT , bool SO>
std::ostream & blaze::operator<< ( std::ostream &  os,
const Matrix< MT, SO > &  m 
)
inline

Global output operator for dense and sparse matrices.

Parameters
osReference to the output stream.
mReference to a constant matrix object.
Returns
Reference to the output stream.
template<typename MT , bool SO>
size_t blaze::rows ( const Matrix< MT, SO > &  m)
inline

Returns the current number of rows of the matrix.

Parameters
mThe given matrix.
Returns
The number of rows of the matrix.
template<typename MT1 , bool SO1, typename MT2 , bool SO2>
void blaze::subAssign ( Matrix< MT1, SO1 > &  lhs,
const Matrix< MT2, SO2 > &  rhs 
)
inline

Default implementation of the subtraction assignment of a matrix to matrix.

Parameters
lhsThe target left-hand side matrix.
rhsThe right-hand side matrix to be subtracted.
Returns
void

This function implements the default subtraction assignment of a matrix to a matrix.
This function must NOT be called explicitly! It is used internally for the performance optimized evaluation of expression templates. Calling this function explicitly might result in erroneous results and/or in compilation errors. Instead of using this function use the assignment operator.