MathArrayBase Entity Reference

Inherits Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor >.

List of all members.


Libraries

Assign 
 The assignment operator for MathArrayBase<TScalar>.
Cols 
 returns the number of cols
ExtractDiagonal 
 extracts the diagonal of the matrix as a vector; needs not to be quadratic
Get 
 returns matrix element given by nrow,ncol, with asserts; also see coeff()
GramSchmidt 
 returns the Gram-Schmidt orthogonalized basis of this matrix
Init 
 sets all elements to zero
IsApprox 
 returns true if other and this are approx. identical
IsApproxToConstant 
 returns true if array is constant and approx. equal s
IsDiagonal 
 returns true if array is a diagonal matrix by precision s
IsIdentity 
 returns true if array is the identity matrix by precision s
IsLowerTriangular 
 returns true if array is a lower triangular matrix by precision s
IsScalar 
 returns true if array is a scalar
IsUnitary 
 returns true if array is a unitary matrix by precision s (is an orthonormal basis)
IsUpperTriangular 
 returns true if array is an upper triangular matrix by precision s
IsVector 
 returns true if array is a vector
IsZero 
 returns true if array is a zero matrix by precision s
ModDiv 
 modifies this matrix by the scalar matrix quotient A/s
ModMul 
 modifies this matrix by the scalar matrix product A*s
Norm 
 returns the l2-norm of this matrix
operator* 
 returns the scalar matrix product A*s
operator/ 
 returns the scalar matrix quotient A/s
Rows 
 returns the number of rows
Set 
 sets the value to all components of the object
SetConstant 
 initializes the matrix with constant values
SetDiagonal 
 sets the diagonal to 'd'; no square matrix required
SetIdentity 
 initializes the matrix as identity matrix
SetLinearMap 
SetOnes 
 initializes the matrix with constant values "1"
SetRandom 
 initializes the matrix with random values
SetZero 
 initializes the matrix with zeros
Sum 
 returns the algebraic sum of all elements
Swap 
 swaps the data pointers of both objects (fastest way to transfer data)
Trace 
 returns the trace of this matrix
Transpose 
 returns the transpose
TransposeInPlace 
 transposes this matrix

Libraries

Constant 
 returns a matrix with constant values
Identity 
 returns a matrix as identity matrix
Ones 
 returns a matrix with constant values "1"
Random 
 returns a matrix with random values
Zero 
 returns a matrix with zeros


Detailed Description

template<typename Scalar>
class tngmath::MathArrayBase< Scalar >

A class that represents storage for dense linalg objects.

The storage scheme is column_major (FORTRAN).

MathArrayBase is a template used by the following object classes:

...


Member Function Documentation

efficiently resizes the matrix to its new dimensions without destroying the contents (no asserts). Internally it creates a copy of the object (nothing if memory is crucial).

returns a matrix consisting of x and this matrix being appended by column. x may be interpreted as a starting set of orthogonal vectors (but are not required to be orthogonal, only independent) The columns which have been appended will be orthogonalized.

modifies this matrix by Gram-Schmidt orthogonalization, whereby only the columns starting at col are considered during orthogonalization.

performs a linear regression of array.

Todo:
parameters docu

find the largest element in the array returns the maximum element in the array

Parameters:
row will be modified and will contain the row position of the found value on return
col will be modified and will contain the column position of the found value on return

find the smallest element in the array returns the minimum element in the array

Parameters:
row will be modified and will contain the row position of the found value on return
col will be modified and will contain the column position of the found value on return

reads the contents of the buffer x into the array. n must be the dimension of x and equal to the dimension of the array. writes the objects to a file. if the extension is '.bin', then the output format is binary. the file is overwritten if existing.

Todo:
docu

Todo:
check parameters (const + reference) + docu

Rotates all columns of array around an axis defined by omega (length of omega is the angle) centr denotes the origin of the rotation

[Library]

sorts the entries in the matrix in the specified column and returns the sorted array 'up' specifies if the items shall be sorted in ascending order

converts this matrix to an XMatrix object (copies data)

converts this matrix to an XMatrix object the data of this object will be deleted afterwards (moves data; is, therefore, fast) converts this matrix to a scalar (in case that it is a scalar)


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

Generated on Wed Nov 17 17:35:52 2010 for 'tngmath' Module Scripting Interface by  doxygen 1.5.6