Class : BlockMatrix

class deriving from Matrix

BlockMatrix :

prototype: BlockMatrix ()

description:default constructor



BlockMatrix :

prototype: BlockMatrix (int , 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



BlockMatrix :

prototype: BlockMatrix (Matrix* matrix )

description:constructor from matrix elements (without duplicating datas)


input parameters:
blocks = list of pointers to matirx to use as block



BlockMatrix :

prototype: BlockMatrix (const BlockMatrix& M )

description:copy constructor (without duplicating datas)


input parameters:
M = matrix to copy



~BlockMatrix :

prototype: ~BlockMatrix ()

description:destructor



operator = :

prototype: BlockMatrix& operator = (const BlockMatrix& 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



GetBlock :

prototype: Matrix* GetBlock (int , int j )

description:get pointer to a given block


input parameters:
i = block line position
j = block column position


return value: pointer to the block



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 BlockMatrix operator + (const BlockMatrix& , const BlockMatrix& M2 )

description:add two matrices


input parameters:
M1 = first matrix
M2 = second matrix


return value: sum of the two matrices



operator - :

prototype: friend BlockMatrix operator - (const BlockMatrix& , const BlockMatrix& 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 BlockMatrix operator * (const BlockMatrix& , 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 BlockMatrix operator * (double , const BlockMatrix& 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 BlockMatrix operator / (const BlockMatrix& , 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: BlockMatrix& operator += (const BlockMatrix& M )

description:add two matrices


input parameters:
M = matrix to add to current matrix


return value: reference on current matrix



operator -= :

prototype: BlockMatrix& operator -= (const BlockMatrix& M )

description:substract two matrices


input parameters:
M = matrix to substract to current matrix


return value: reference on current matrix



operator *= :

prototype: BlockMatrix& 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: BlockMatrix& 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 BlockMatrix& 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 BlockMatrix& 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.