tngmath::Matrix Class Reference

The standard dense Matrix/Vector class. More...

#include <matrix.hpp>

Inheritance diagram for tngmath::Matrix:

[legend]

Collaboration diagram for tngmath::Matrix:

[legend]

List of all members.

Public Member Functions
MatrixColWise	ColWise ()
MatrixCWise	CWise ()
MatrixEigen	Eigen ()
MatrixEigenSym	EigenSym (const Matrix &mass, bool computeeigenvectors=true)
MatrixEigenSym	EigenSym (bool computeeigenvectors=true)
void	EigenSymInPlace (const MathArrayBase< TScalar > &mass, Matrix **eval, Matrix **evec) const
void	EigenSymInPlace (Matrix **eval, Matrix **evec) const
MatrixEigenSymUpper	EigenSymUpper (bool computeeigenvectors=true)
MatrixLDLT	LDLT ()
MatrixLLT	LLT ()
MatrixLU	LU ()
	Matrix (const TIndex &nrow, const TIndex &ncol=1)
	constructs a matrix and allocates nrow*ncol elements
template<typename OtherDerived>
	Matrix (const Eigen::MatrixBase< OtherDerived > &x)
	copy constructor from Eigen objects
	Matrix (const SparseMatrix &ar)
	copy constructor
	Matrix (const MathArrayBase< double > &ar)
	copy constructor
	Matrix ()
	default constructor
MatrixQR	QR ()
MatrixRowWise	RowWise ()
MatrixSVD	SVD ()
void	SVDInPlace (Matrix **svalues, Matrix **mat_U, Matrix **mat_V) const

---

Detailed Description

The standard dense Matrix/Vector class.

The default array class 'Matrix' which is of type 'MathArrayBase' with scalar 'double' precision

Matrix provides basic linear algebra for vector, matrix and scalar operations.

The type Matrix is a specialization of the template type MathArrayBase<>, whereby the base type is a real number of double precision. Moreover, the following type identifiers are defined within Matrix:

• Scalar is a scalar real number.
• TScalar is the same as Scalar.
• TIndex is a scalar integer number.
• MathArrayBase<TScalar> is a synonym for Matrix. Further types are:
• TBuffer is a data buffer of Scalar (a C array/pointer)
• Base is the underlying base type of Matrix.

---

Member Function Documentation

MatrixColWise tngmath::Matrix::ColWise

(

)

[inline]

Returns:

a MatrixColWise expression

Reimplemented in tngmath::XMatrix.

MatrixCWise tngmath::Matrix::CWise

(

)

[inline]

Returns:

a MatrixCWise expression

Reimplemented in tngmath::XMatrix.

MatrixEigen tngmath::Matrix::Eigen

(

)

Returns:

an Eigen decomposition object

Reimplemented in tngmath::XMatrix.

MatrixEigenSym tngmath::Matrix::EigenSym	(	const Matrix &	mass,
		bool	computeeigenvectors = true
	)

Returns:

a generalized symmetric Eigen decomposition object

MatrixEigenSym tngmath::Matrix::EigenSym

(

bool

computeeigenvectors = true

)

Returns:

a symmetric Eigen decomposition object

Reimplemented in tngmath::XMatrix.

MatrixEigenSymUpper tngmath::Matrix::EigenSymUpper

(

bool

computeeigenvectors = true

)

Returns:

a symmetric (lower triangular) Eigen decomposition object

a symmetric (upper triangular) Eigen decomposition object

MatrixLDLT tngmath::Matrix::LDLT

(

)

Returns:

an LDL decomposition object

Reimplemented in tngmath::XMatrix.

MatrixLLT tngmath::Matrix::LLT

(

)

Returns:

an LLT decomposition object

Reimplemented in tngmath::XMatrix.

MatrixLU tngmath::Matrix::LU

(

)

Returns:

an LU decomposition object

Reimplemented in tngmath::XMatrix.

MatrixQR tngmath::Matrix::QR

(

)

Returns:

an QRecomposition object

Reimplemented in tngmath::XMatrix.

MatrixRowWise tngmath::Matrix::RowWise

(

)

[inline]

Returns:

a MatrixRowWise expression

Reimplemented in tngmath::XMatrix.

MatrixSVD tngmath::Matrix::SVD

(

)

Returns:

an SVD decomposition object

Reimplemented in tngmath::XMatrix.

---

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

• modules/tngmath/tngmath/matrix.hpp