XMatrix Entity Reference

A class that extends Matrix by many convenience methods. More...

Inherits tngmath::Matrix.

List of all members.

Libraries
AutoSpectrum
ColWise
CrossSpectrum
CWise
operator=
	The assignment operator for MathArrayBase<TScalar>.
RowWise
Wave
	calls Wave with jtot=number_of_rows/2
XMatrix
	constructs a matrix and allocates nrow*ncol elements
~XMatrix
	destructor

---

Detailed Description

A class that extends Matrix by many convenience methods.

For most users which do not look at compatbility and efficiency, this data type is the basic choice. XMatrix extends Matrix by a lot of convenience methods from statistics, linear algebra, Fourier analyses, etc.

XMatrix has been split into 2 types due to developing reasons. Matrix does not depend on external packages (it provides simple operations), whereas XMatrix requires third-party libraries. Therefore, most TNG modules will export their data as Matrix. If the user wants to use the extended functionality he must convert it into a XMatrix.

developers note: For compatibility reasons with Matrix, all input parameters are of type 'Matrix' (then both, Matrix and XMatrix, are allowed) and all output parameters are of type 'XMatrix' (for subsequent operations)

---

Member Function Documentation

Todo:

: Bucher

[Library]

Todo:

: Bucher

Todo:

: Bucher

Todo:

: Bucher

returns the Cholesky decomposition of the parent matrix, i.e. the parent matrix must be real symmetric and positive definite.

Todo:

: Bucher

Todo:

: Bucher

[Library]

Returns:

a XMatrixColWise expression

Reimplemented from Matrix.

Todo:

: Bucher

returns the covariance matrix of the parent array weighted by a parameter.

Parameters:

ar

Todo:

: Bucher

Todo:

: Bucher

[Library]

Todo:

: Bucher

[Library]

Returns:

a XMatrixCWise expression

Reimplemented from Matrix.

Returns:

an Eigen decomposition object

Reimplemented from Matrix.

Todo:

bucher

Todo:

bucher

Returns:

a symmetric (lower triangular) Eigen decomposition object

a symmetric (upper triangular) Eigen decomposition object

a generalized symmetric Eigen decomposition object

Returns:

a symmetric Eigen decomposition object

Reimplemented from Matrix.

Todo:

bucher

Todo:

bucher

returns the matrix exponential of the parent matrix

Parameters:

dt

denotes the exponent.

Todo:

: Bucher

Todo:

: Bucher

Todo:

: Bucher

Todo:

: Bucher

returns the inverse of a square parent matrix.

Todo:

Bucher: Welcher Algorithmus?

returns the inverse of the parent matrix if it is complex

Todo:

Bucher: Details

Todo:

: Bucher

Returns:

an LDL decomposition object

Reimplemented from Matrix.

Returns:

an LLT decomposition object

Reimplemented from Matrix.

Returns:

an LU decomposition object

Reimplemented from Matrix.

returns the mean of the parent array whereby it is weighted by the given parameter.

Parameters:

ar

is a vector with same number of rows as the parent array. Every row of the parent array will be weighted by the corresponding item of ar divided by the elementwise sum of ar.

Todo:

: Bucher

Returns:

an QRecomposition object

Reimplemented from Matrix.

Todo:

: Bucher

[Library]

Returns:

a XMatrixRowWise expression

Reimplemented from Matrix.

returns the standard deviation as the square root of the covariance

Parameters:

ar

denotes the array of which Covariance(ar) is called.

returns the solution of a linear system of equations with given right hand side vector. Solves where is unknown.

Parameters:

rhs

denotes the vector

Returns:

an SVD decomposition object

Reimplemented from Matrix.

Todo:

bucher

Todo:

: Bucher

---

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

• modules/tngmath/tngmath/xmatrix.hpp