Class : RealLowerTriangularMatrix
RealLowerTriangularMatrix :
prototype: RealLowerTriangularMatrix ()
description:default constructor
RealLowerTriangularMatrix :
prototype: RealLowerTriangularMatrix (int , bool zero = false )
description:constructor for an empty matrix
input parameters:
dimension = matrix dimension
zero = true if matrix has to be filled with zeros
RealLowerTriangularMatrix :
prototype: RealLowerTriangularMatrix (double* , double* , int dimension )
description:constructor from matrix elements (without duplicating datas)
input parameters:
diagonal = pointer to diagonal element array
offDiagonal = pointer to off-diagonal element array
dimension = matrix dimension
RealLowerTriangularMatrix :
prototype: RealLowerTriangularMatrix (const RealLowerTriangularMatrix& M )
description:copy constructor (without duplicating datas)
input parameters:
M = matrix to copy
RealLowerTriangularMatrix :
prototype: RealLowerTriangularMatrix (const RealTriDiagonalSymmetricMatrix& M )
description:copy constructor from a real tridiagonal symmetric matrix (without duplicating diagonal elements)
input parameters:
M = matrix to copy
~RealLowerTriangularMatrix :
prototype: ~RealLowerTriangularMatrix ()
description:destructor
operator = :
prototype: RealLowerTriangularMatrix& operator = (const RealLowerTriangularMatrix& M )
description:assignement (without duplicating datas)
input parameters:
M = matrix to copy
return value: reference on modified matrix
operator = :
prototype: RealLowerTriangularMatrix& operator = (const RealTriDiagonalSymmetricMatrix& M )
description:assignement from a real tridiagonal symmetric matrix (without duplicating datas)
input parameters:
M = matrix to copy
return value: reference on modified matrix
Clone :
prototype: Matrix* Clone ()
description:return pointer on a clone matrix (without duplicating datas)
input parameters:
retrun value = pointer on new matrix
SetMatrixElement :
prototype: void SetMatrixElement (int , int , double x )
description:set a matrix element
input parameters:
i = line position
j = column position
x = new value for matrix element
SetMatrixElement :
prototype: void SetMatrixElement (int , int , const Complex& x )
description:set a matrix element
input parameters:
i = line position
j = column position
x = new value for matrix element
AddToMatrixElement :
prototype: void AddToMatrixElement (int , int , double x )
description:add a value to a matrix element
input parameters:
i = line position
j = column position
x = value to add to matrix element
AddToMatrixElement :
prototype: void AddToMatrixElement (int , int , const Complex& x )
description:add a value a matrix element
input parameters:
i = line position
j = column position
x = value to add to matrix element
operator [] :
prototype: double& operator [] (int i )
description:get reference of a given diagonal matrix element
input parameters:
i = line position
return value: reference on matrix diagonal elememt
operator :
prototype: double& operator ( )
description:get reference of a given matrix element
input parameters:
i = line position
j = column position
return value: reference om matrix elememt
Resize :
prototype: void Resize (int , int nbrColumn )
description:Resize matrix
input parameters:
nbrRow = new number of rows
nbrColumn = new number of columns
ResizeAndClean :
prototype: void ResizeAndClean (int , int nbrColumn )
description:Resize matrix and set to zero all elements that have been added
input parameters:
nbrRow = new number of rows
nbrColumn = new number of columns
operator + :
prototype: friend RealLowerTriangularMatrix operator + (const RealLowerTriangularMatrix& ,
const RealLowerTriangularMatrix& M2 )
description:add two matrices
input parameters:
M1 = first matrix
M2 = second matrix
return value: sum of the two matrices
operator - :
prototype: friend RealLowerTriangularMatrix operator - (const RealLowerTriangularMatrix& ,
const RealLowerTriangularMatrix& M2 )
description:substract two matrices
input parameters:
M1 = first matrix
M2 = matrix to substract to M1
return value: difference of the two matrices
operator * :
prototype: friend RealMatrix operator * (RealMatrix& , const RealLowerTriangularMatrix& m2 )
description:multiply a real matrix with a real lower triangular matrix
input parameters:
m1 = real matrix
m2 = real lower triangular matrix
return value: product result
operator * :
prototype: friend RealLowerTriangularMatrix operator * (const RealLowerTriangularMatrix& , double x )
description:multiply a matrix by a real number (right multiplication)
input parameters:
M = source matrix
x = real number to use
return value: product result
operator * :
prototype: friend RealLowerTriangularMatrix operator * (double , const RealLowerTriangularMatrix& M )
description:multiply a matrix by a real number (left multiplication)
input parameters:
M = source matrix
x = real number to use
return value: product result
operator / :
prototype: friend RealLowerTriangularMatrix operator / (const RealLowerTriangularMatrix& , double x )
description:divide a matrix by a real number (right multiplication)
input parameters:
M = source matrix
x = real number to use
return value: division result
operator += :
prototype: RealLowerTriangularMatrix& operator += (const RealLowerTriangularMatrix& M )
description:add two matrices
input parameters:
M = matrix to add to current matrix
return value: reference on current matrix
operator -= :
prototype: RealLowerTriangularMatrix& operator -= (const RealLowerTriangularMatrix& M )
description:substract two matrices
input parameters:
M = matrix to substract to current matrix
return value: reference on current matrix
operator *= :
prototype: RealLowerTriangularMatrix& operator *= (double x )
description:multiply a matrix by a real number
input parameters:
x = real number to use
return value: reference on current matrix
operator /= :
prototype: RealLowerTriangularMatrix& operator /= (double x )
description:divide a matrix by a real number
input parameters:
x = real number to use
return value: reference on current matrix
MatrixElement :
prototype: double MatrixElement (RealVector& , RealVector& V2 )
description:evaluate matrix element
input parameters:
V1 = vector to left multiply with current matrix
V2 = vector to right multiply with current matrix
return value: corresponding matrix element
Tr :
prototype: double Tr ()
description:evaluate matrix trace
input parameters:
return value: matrix trace
Det :
prototype: double Det ()
description:evaluate matrix determinant
input parameters:
return value: matrix determinant
operator << :
prototype: friend ostream& operator << (ostream& , const RealLowerTriangularMatrix& P )
description:Output Stream overload
input parameters:
Str = reference on output stream
P = matrix to print
return value: reference on output stream
operator << :
prototype: friend MathematicaOutput& operator << (MathematicaOutput& , const RealLowerTriangularMatrix& P )
description:Mathematica Output Stream overload
input parameters:
Str = reference on Mathematica output stream
P = matrix to print
return value: reference on output stream
operator >> :
prototype: friend ifstream& operator >> (ifstream& , RealLowerTriangularMatrix& matrix )
description:output file stream overload
input parameters:
file = reference on output file stream
matrix = reference on matrix to save
return value: reference on output file stream
friend ofstream& operator << (ofstream& file, const RealLowerTriangularMatrix& matrix);
input file stream overload
input parameters:
file = reference on output file stream
matrix = reference on matrix to load
return value: reference on output file stream
Back to index.