Class : RealMatrix
RealMatrix :
prototype: RealMatrix ()
description:default constructor
RealMatrix :
prototype: RealMatrix (int , int , bool zero = false )
description:constructor for an empty matrix
input parameters:
nbrRow = number of rows
nbrColumn = number of columns
zero = tue if matrix elements have to be set to zero
RealMatrix :
prototype: RealMatrix (RealVector* , int nbrColumn )
description:constructor from matrix elements (without duplicating datas)
input parameters:
columns = pointer an array of vector
nbrColumn = number of columns
RealMatrix :
prototype: RealMatrix (const RealMatrix& M )
description:copy constructor (without duplicating datas)
input parameters:
M = matrix to copy
RealMatrix :
prototype: RealMatrix (Matrix& M )
description:copy constructor (duplicating all datas)
input parameters:
M = matrix to copy
~RealMatrix :
prototype: ~RealMatrix ()
description:destructor
operator = :
prototype: RealMatrix& operator = (const RealMatrix& M )
description:assignement (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 ( )
description:get reference of a given matrix element
input parameters:
i = line position
j = column position
return value: reference om matrix elememt
operator [] :
prototype: RealVector& operator [] (int i )
description:get reference to a given column
input parameters:
i = column position
return value: column reference
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 RealMatrix operator + (const RealMatrix& , const RealMatrix& M2 )
description:add two matrices
input parameters:
M1 = first matrix
M2 = second matrix
return value: sum of the two matrices
operator + :
prototype: friend RealMatrix operator + (const RealTriDiagonalSymmetricMatrix& , const RealMatrix& M2 )
description:add two matrices where the left one is a real tridiagonal symmetric matrix
input parameters:
M1 = left matrix
M2 = right matrix
return value: sum of the two matrices
operator + :
prototype: friend RealMatrix operator + (const RealMatrix& , const RealTriDiagonalSymmetricMatrix& M2 )
description:add two matrices where the right one is a real tridiagonal symmetric matrix
input parameters:
M1 = left matrix
M2 = right matrix
return value: sum of the two matrices
operator - :
prototype: friend RealMatrix operator - (const RealMatrix& , const RealMatrix& 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 - (const RealTriDiagonalSymmetricMatrix& , const RealMatrix& M2 )
description:substract two matrices where the left one is a real tridiagonal symmetric matrix
input parameters:
M1 = first matrix
M2 = matrix to substract to M1
return value: difference of the two matrices
operator - :
prototype: friend RealMatrix operator - (const RealMatrix& , const RealTriDiagonalSymmetricMatrix& M2 )
description:substract two matrices where the right one is a real tridiagonal symmetric matrix
input parameters:
M1 = first matrix
M2 = matrix to substract to M1
return value: difference of the two matrices
operator * :
prototype: friend RealMatrix operator * (const RealMatrix& , const RealMatrix& M2 )
description:multiply two matrices
input parameters:
M1 = first matrix
M2 = matrix to multiply to M1
return value: product of the two matrices
operator * :
prototype: friend RealMatrix operator * (const RealMatrix& , 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 RealMatrix operator * (double , const RealMatrix& 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
Multiply :
prototype: RealMatrix& Multiply (const RealMatrix& M )
description:multiply a matrix to the right by another matrix without using temporary matrix
input parameters:
M = matrix used as multiplicator
return value: reference on current matrix
Multiply :
prototype: RealMatrix& Multiply (const RealMatrix& , int , int nbrLine )
description:multiply a matrix to the right by another matrix without using temporary matrix and in a given range of indices
beware the matrix is not resized after multiplication in order the operation to be thread safe
input parameters:
M = matrix used as multiplicator
startLine = starting line in destination matrix
nbrLine = number of lines to multiply
return value: reference on current matrix
operator / :
prototype: friend RealMatrix operator / (const RealMatrix& , 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: RealMatrix& operator += (const RealMatrix& M )
description:add two matrices
input parameters:
M = matrix to add to current matrix
return value: reference on current matrix
operator += :
prototype: RealMatrix& operator += (const RealTriDiagonalSymmetricMatrix& M )
description:add two matrices where the right one is a real tridiagonal symmetric matrix
input parameters:
M = matrix to add to current matrix
return value: reference on current matrix
operator -= :
prototype: RealMatrix& operator -= (const RealMatrix& M )
description:substract two matrices
input parameters:
M = matrix to substract to current matrix
return value: reference on current matrix
operator -= :
prototype: RealMatrix& operator -= (const RealTriDiagonalSymmetricMatrix& M )
description:substract two matrices where the right one is a real tridiagonal symmetric matrix
input parameters:
M = matrix to substract to current matrix
return value: reference on current matrix
operator *= :
prototype: RealMatrix& 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: RealMatrix& operator /= (double x )
description:divide a matrix by a real number
input parameters:
x = real number to use
return value: reference on current matrix
NormalizeColumns :
prototype: RealMatrix& NormalizeColumns ()
description:normalize matrix column vectors
input parameters:
return value: reference on current matrix
Transpose :
prototype: RealMatrix& Transpose ()
description:transpose matrix
input parameters:
return value: reference on current matrix
operator << :
prototype: friend ostream& operator << (ostream& , const RealMatrix& 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 RealMatrix& P )
description:Mathematica Output Stream overload
input parameters:
Str = reference on Mathematica output stream
P = matrix to print
return value: reference on output stream
Back to index.