Simple matrix class for performing fast operations on matrices of sizes known at compile-time. More...

#include </home/werner/origo/vish/ocean/eagle/Matrix.hpp>

Public Types

enum { rows = R }
enum { columns = C, cols = C }
typedef Vector< Value, R *C > Base_t
typedef Matrix Matrix_t
Matrix type.
typedef Value value_type

Public Member Functions

Column< R, Value > column (int i) const
Return the ith column of this matrix.
Value & getElement (int element)
const Value & getElement (int element) const
const Matrix_t & matrix () const
yield matrix here, useful for derived classes.
Matrix_t & matrix ()
Value & operator() (int row, int column)
Access element for writing.
const Value & operator() (int row, int column) const
Element access operation for reading.
const Row< R, Value > & operator[] (int column) const
Allow nested access to matrix elements via bracket operator.
Row< R, Value > & operator[] (int column)
Allow nested access to matrix elements via bracket operator.
Row< R, Value > & row (int column)
Return writable reference to the ith row of this matrix.
const Row< R, Value > & row (int column) const
Return read-only reference to the ith row of this matrix.
Base_t & vvec ()
const Base_t & vvec () const

Constructors

Matrix ()
Default constructor.
Matrix (const Matrix &M)
Copy constructor.
Matrix (const Base_t &V)
Construct matrix from linear vector.

Arithmetic operations

typedef Operator<'*'> Mult
Computational constructor argument for multiplicative operations.
typedef Operator<'~'> TransposeOperation
Computational constructor argument for transpose operations.
Matrix (const Matrix &A, const Value &V, const Operator<'*'> &M)
Computational constructor for multiplying matrix by scalar.
Matrix (const Value &V, const Matrix &A, const Operator<'*'> &M)
Computational constructor for multiplying scalar by matrix.
Matrix (const Matrix &A, const Value &V, const Operator<'/'> &Op)
Computational constructor for dividing matrix by scalar.
Matrix (const Matrix &A, const Matrix &B, const Operator<'+'> &Op)
Computational constructor for matrix addition.
Matrix (const Matrix &A, const Matrix &B, const Operator<'-'> &Op)
Computational constructor for matrix subtraction.
template<class AType , class BType , OperatorID_t CompType> Matrix (const FixedArray< AType, R *C > &l, const FixedArray< BType, R *C > &r, const Operator< CompType > &Op)
Generic computational constructor for two arrays of size compatible with the matrix.
template<class Type > Matrix (const FixedArray< Type, R *C > &Data)
Explicit constructor from arbitrary compatible type.
template<class ValueType , OperatorID_t CompType> Matrix (const FixedArray< ValueType, R > &l, const Operator< CompType > &Op, const Value &scalar)
Generic computational constructor for vector/scalar operations.
template<class ValueType , OperatorID_t CompType> Matrix (const Operator< CompType > &Op, const Value &scalar, const FixedArray< ValueType, R > &l)
Generic computational constructor for scalar/vector operations.
Matrix (const Matrix &A, const Operator<'-'> &Op)
Computational constructor for unary minus.
template<int M, class ValueA , class ValueB > Matrix (const Matrix< R, M, ValueA > &A, const Matrix< M, C, ValueB > &B, const Operator<'*'> &)
Matrix multiplication .
template<int M, class ValueA , class ValueB > Matrix (const Matrix< R, M, ValueA > &A, const Matrix< C, M, ValueB > &B, const Operator<'*','~'> &)
Transposed matrix multiplication $A B^{\tau}$ .
template<int M> Matrix (const Matrix< R, M, Value > &A, const Matrix< C, M, Value > &B, const Mult &, const TransposeOperation &)
Matrix multiplication with transpose of matrix B This code is UNTESTED! Verify before usage!
template<int M> Matrix (const Matrix< M, R, Value > &A, const Matrix< M, C, Value > &B, const TransposeOperation &, const Mult &)
Matrix multiplication with transpose of matrix A This code is UNTESTED! Verify before usage!
Matrix (const Matrix< R, C, Value > &A, const LowerTriangular< C, Value > &B, const Mult &)
Matrix multiplication where B is a symmetric matrix stored in lower triangular form.
Matrix (const Matrix< C, R, Value > &A, const LowerTriangular< C, Value > &B, const TransposeOperation &, const Mult &)
Matrix multiplication where B is a symmetric matrix stored in lower triangular form.
Matrix operator+ (const Matrix &A, const Matrix &B)
Add matrices.
Matrix operator* (const Matrix &A, const Value &V)
Matrix operator* (const Value &V, const Matrix &A)
template<int M> Matrix operator* (const Matrix< R, M, Value > &A, const Matrix< M, C, Value > &B)
Matrix product.
template<int M, class ValueA , class ValueB > Matrix matrix_mult (const Matrix< R, M, ValueA > &A, const Matrix< M, C, ValueB > &B)
Matrix product, version as function.
template<int M, class ValueA , class ValueB > Matrix matrix_mult_transp (const Matrix< R, M, ValueA > &A, const Matrix< C, M, ValueB > &B)
Transposed matrix product, version as function.
template<int M, class ValueA , class ValueB > Matrix matrix_transform (const Matrix< R, M, ValueA > &A, const Matrix< C, M, ValueB > &B)

Detailed Description

Simple matrix class for performing fast operations on matrices of sizes known at compile-time.

All operations are implemented as inline functions using computational constructors, such that simple operations don't require any temporaries. However, advanced techniques like expression templates are not employed here, so complex operations will require temporary objects. The intentional use are small, fast operations with compile time check of operational consistency.

Parameters:

R	rows
C	columns

The layout is given as (column,row) indexing according to a matrix A as

$A = \begin{pmatrix} A_{0,0} & \dots & A_{c-1,0} \\ &\dots& \\ A_{0,r-1} & \dots & A_{c-1,r-1} \end{pmatrix}$

. The elements are stored row-wise, such that a matrix is a collection of rows. By specification of the column it is thus possible to a view to the respective row.

See also:: LowerTriangular, Matrix, Row, Column

Examples:: Matrix.cpp.

Constructor & Destructor Documentation

template<int M, class ValueA , class ValueB >

Eagle::Matrix::Matrix	(	const Matrix< R, M, ValueA > &	A,
		const Matrix< M, C, ValueB > &	B,
		const Operator<'*'> &
	)		`[inline]`

Matrix multiplication $ A B$ .

Test matrix multiplication!!! Optimize for row-wise contraction!

$M_{rc} = \Sigma_m A_{rm} B_{mc}$

template<int M, class ValueA , class ValueB >

Eagle::Matrix::Matrix	(	const Matrix< R, M, ValueA > &	A,
		const Matrix< C, M, ValueB > &	B,
		const Operator<'*','~'> &
	)		`[inline]`

Transposed matrix multiplication $A B^{\tau}$ .

Test matrix multiplication!!! Optimize for row-wise contraction!

$M_{rc} = \Sigma_m A_{rm} B_{cm}$

Eagle::Matrix::Matrix	(	const Matrix< R, C, Value > &	A,
		const LowerTriangular< C, Value > &	B,
		const Mult &
	)		`[inline]`

Matrix multiplication $ A B$ where B is a symmetric matrix stored in lower triangular form.

This code is UNTESTED! Verify before usage! Optimize for symmetries on the operation!

Eagle::Matrix::Matrix	(	const Matrix< C, R, Value > &	A,
		const LowerTriangular< C, Value > &	B,
		const TransposeOperation &	,
		const Mult &
	)		`[inline]`

Matrix multiplication $ A^t B$ where B is a symmetric matrix stored in lower triangular form.

This code is UNTESTED! Verify before usage! Optimize for symmetries on the operation!

Member Function Documentation

Value& Eagle::Matrix::operator()	(	int	row,
		int	column
	)		`[inline]`

Access element for writing.

The memory layout is set up according to

          M[ i+j*ROWS ] = M[i][j].

such that linear access to the elements works through the comma assignment operator:

        Matrix<3,4,double>      A;

        A = 1,0,0,
            0,1,0,
            0,0,1,
            0,0,0;

Row<R, Value>& Eagle::Matrix::row ( int column ) [inline]

Return writable reference to the ith row of this matrix.

Note that the result is not a vectorized vector (and thus not of type Row<>), because it is possibly not aligned as required by a vectorized vector.

const Row<R, Value>& Eagle::Matrix::row ( int column ) const [inline]

Return read-only reference to the ith row of this matrix.

Note that the result is not a vectorized vector (and thus not of type Row<>), because it is possibly not aligned as required by a vectorized vector.

The documentation for this class was generated from the following file:

ocean/eagle/Matrix.hpp