1.3.1
CCC
 
AMatrixDense Class Reference

#include <AMatrixDense.hpp>

Inheritance diagram for AMatrixDense:
AMatrix AStringable ICloneable MatrixRectangular AMatrixSquare Table MatrixSquareGeneral MatrixSquareSymmetric

Detailed Description

Dense Matrix This class provides all the functions that can be performed using a Matrix stored in "Dense" format (in opposition to the "Sparse" format). This class can be derived in the case the matrix is Square, and even more if it is Square and Symmetric.

Public Member Functions

 AMatrixDense (int nrow=0, int ncol=0)
 
 AMatrixDense (const AMatrixDense &m)
 
 AMatrixDense (const AMatrix &m)
 
AMatrixDenseoperator= (const AMatrixDense &r)
 
virtual ~AMatrixDense ()
 
bool isDense () const override
 Interface for AMatrix. More...
 
bool isSparse () const override
 
void setValue (int irow, int icol, double value, bool flagCheck=false) override
 
virtual double getValue (int irow, int icol, bool flagCheck=false) const override
 
void updValue (int irow, int icol, const EOperator &oper, double value, bool flagCheck=false) override
 
virtual void setColumn (int icol, const VectorDouble &tab) override
 
virtual void setRow (int irow, const VectorDouble &tab) override
 
virtual void setDiagonal (const VectorDouble &tab) override
 
virtual void setDiagonalToConstant (double value=1.) override
 
virtual void addScalar (double v) override
 
virtual void addScalarDiag (double v) override
 
virtual void prodScalar (double v) override
 
virtual void fill (double value) override
 
virtual void multiplyRow (const VectorDouble &vec) override
 
virtual void multiplyColumn (const VectorDouble &vec) override
 
virtual void divideRow (const VectorDouble &vec) override
 
virtual void divideColumn (const VectorDouble &vec) override
 
virtual VectorDouble prodVecMat (const VectorDouble &x, bool transpose=false) const override
 
virtual VectorDouble prodMatVec (const VectorDouble &x, bool transpose=false) const override
 
virtual VectorDouble getRow (int irow) const override
 
virtual VectorDouble getColumn (int icol) const override
 
virtual void prodMatMatInPlace (const AMatrix *x, const AMatrix *y, bool transposeX=false, bool transposeY=false) override
 
void addMatInPlace (const AMatrixDense &y, double cx=1., double cy=1.)
 The next functions use specific definition of matrix (to avoid dynamic_cast) rather than manipulating AMatrix. They are not generic of AMatrix anymore. WARNING: output matrix should not match any of input matrices (speed up). More...
 
virtual void prodNormMatMatInPlace (const AMatrixDense &a, const AMatrixDense &m, bool transpose=false)
 
virtual void prodNormMatInPlace (const AMatrixDense &a, const VectorDouble &vec=VectorDouble(), bool transpose=false)
 
VectorDouble getEigenValues () const
 
const MatrixSquareGeneralgetEigenVectors () const
 
- Public Member Functions inherited from AMatrix
 AMatrix (int nrow=0, int ncol=0)
 
 AMatrix (const AMatrix &m)
 
AMatrixoperator= (const AMatrix &m)
 
virtual ~AMatrix ()
 
virtual void reset (int nrows, int ncols)
 
virtual void resetFromValue (int nrows, int ncols, double value)
 Reset the matrix to new dimensions and fill with a new value. More...
 
virtual void resetFromArray (int nrows, int ncols, const double *tab, bool byCol=true)
 Reset the matrix from an array of double values. More...
 
virtual void resetFromVD (int nrows, int ncols, const VectorDouble &tab, bool byCol=true)
 Reset the matrix from a vector of double values. More...
 
virtual void resetFromVVD (const VectorVectorDouble &tab, bool byCol=true)
 Reset the matrix from an array of double values. More...
 
virtual String toString (const AStringFormat *strfmt=nullptr) const override
 Interface to AStringable. More...
 
virtual bool isSquare (bool printWhyNot=false) const
 
virtual bool isValid (int irow, int icol, bool printWhyNot=false) const
 
virtual bool isIdentity (bool printWhyNot=false) const
 
virtual bool isSymmetric (bool printWhyNot=false, double eps=EPSILON10) const
 
virtual bool mustBeSymmetric () const
 
virtual void transposeInPlace ()
 
virtual AMatrixtranspose () const
 
virtual NF_Triplet getMatrixToTriplet (int shiftRow=0, int shiftCol=0) const
 
void addMatInPlace (const AMatrix &y, double cx=1., double cy=1.)
 
void prodMatInPlace (const AMatrix *matY, bool transposeY=false)
 
void prodNormMatMatInPlace (const AMatrix &a, const AMatrix &m, bool transpose=false)
 
void prodNormMatInPlace (const AMatrix &a, const VectorDouble &vec=VectorDouble(), bool transpose=false)
 
void resize (int nrows, int ncols)
 Resize the matrix to new dimensions (this method doesn't change the storage type) More...
 
void addValue (int irow, int icol, double value)
 
bool isSame (const AMatrix &m, double eps=EPSILON4, bool printWhyNot=false)
 
bool isSameSize (const AMatrix &m) const
 
bool empty () const
 
double compare (const AMatrix &mat) const
 
int getNRows () const
 
int getNCols () const
 
int size () const
 
VectorDouble getValues (bool byCol=true) const
 
VectorDouble getDiagonal (int shift=0) const
 
bool isColumnDefined (int icol) const
 
bool isRowDefined (int irow) const
 
int getNumberColumnDefined () const
 
int getNumberRowDefined () const
 
bool isNonNegative (bool verbose=false)
 
void prodMatVecInPlace (const VectorDouble &x, VectorDouble &y, bool transpose=false) const
 
void prodMatVecInPlacePtr (const double *x, double *y, bool transpose=false) const
 
void prodVecMatInPlace (const VectorDouble &x, VectorDouble &y, bool transpose=false) const
 
void prodVecMatInPlacePtr (const double *x, double *y, bool transpose=false) const
 
double quadraticMatrix (const VectorDouble &x, const VectorDouble &y)
 
int invert ()
 
int solve (const VectorDouble &b, VectorDouble &x) const
 
void dumpElements (const String &title, int ifrom, int ito) const
 
void setIdentity (double value=1.)
 
void fillRandom (int seed=432432, double zeroPercent=0.1)
 
void setValues (const VectorDouble &values, bool byCol=true)
 
double getMeanByColumn (int icol) const
 
double getMinimum () const
 
double getMaximum () const
 
double getNormInf () const
 
void copyReduce (const AMatrix *x, const VectorInt &activeRows, const VectorInt &activeCols)
 
void copyElements (const AMatrix &m, double factor=1.)
 
void setFlagCheckAddress (bool flagCheckAddress)
 
void makePositiveColumn ()
 
void linearCombination (double val1, const AMatrix *mat1, double val2=1., const AMatrix *mat2=nullptr)
 
double operator() (int row, int col) const
 
double & operator() (int row, int col)
 
- Public Member Functions inherited from AStringable
 AStringable ()
 
 AStringable (const AStringable &r)
 
AStringableoperator= (const AStringable &r)
 
virtual ~AStringable ()
 
virtual void display (const AStringFormat *strfmt=nullptr) const final
 
virtual void display (int level) const final
 
- Public Member Functions inherited from ICloneable
 ICloneable ()
 
virtual ~ICloneable ()
 
virtual ICloneableclone () const =0
 

Constructor & Destructor Documentation

◆ AMatrixDense() [1/3]

AMatrixDense::AMatrixDense ( int  nrow = 0,
int  ncol = 0 
)

◆ AMatrixDense() [2/3]

AMatrixDense::AMatrixDense ( const AMatrixDense m)

◆ AMatrixDense() [3/3]

AMatrixDense::AMatrixDense ( const AMatrix m)

◆ ~AMatrixDense()

AMatrixDense::~AMatrixDense ( )
virtual

Member Function Documentation

◆ addMatInPlace()

void AMatrixDense::addMatInPlace ( const AMatrixDense y,
double  cx = 1.,
double  cy = 1. 
)

The next functions use specific definition of matrix (to avoid dynamic_cast) rather than manipulating AMatrix. They are not generic of AMatrix anymore. WARNING: output matrix should not match any of input matrices (speed up).

Add a matrix (multiplied by a constant)

◆ addScalar()

void AMatrixDense::addScalar ( double  v)
overridevirtual

Add a value to each matrix component

Reimplemented from AMatrix.

◆ addScalarDiag()

void AMatrixDense::addScalarDiag ( double  v)
overridevirtual

Add value to matrix diagonal

Reimplemented from AMatrix.

◆ divideColumn()

void AMatrixDense::divideColumn ( const VectorDouble vec)
overridevirtual

Divide a Matrix column-wise

Reimplemented from AMatrix.

◆ divideRow()

void AMatrixDense::divideRow ( const VectorDouble vec)
overridevirtual

Divide a Matrix row-wise

Reimplemented from AMatrix.

◆ fill()

void AMatrixDense::fill ( double  value)
overridevirtual

Set all the values of the Matrix at once

Reimplemented from AMatrix.

◆ getColumn()

VectorDouble AMatrixDense::getColumn ( int  icol) const
overridevirtual

Extract a Column

Reimplemented from AMatrix.

◆ getEigenValues()

VectorDouble AMatrixDense::getEigenValues ( ) const
inline

◆ getEigenVectors()

const MatrixSquareGeneral* AMatrixDense::getEigenVectors ( ) const
inline

◆ getRow()

VectorDouble AMatrixDense::getRow ( int  irow) const
overridevirtual

Extract a Row

Reimplemented from AMatrix.

◆ getValue()

double AMatrixDense::getValue ( int  irow,
int  icol,
bool  flagCheck = false 
) const
overridevirtual

Get the value from a matrix cell

Implements AMatrix.

◆ isDense()

bool AMatrixDense::isDense ( ) const
inlineoverridevirtual

Interface for AMatrix.

Returns if the matrix belongs to the MatrixSparse class (avoids dynamic_cast)

Implements AMatrix.

◆ isSparse()

bool AMatrixDense::isSparse ( ) const
inlineoverridevirtual

Returns if the current matrix is Sparse

Implements AMatrix.

◆ multiplyColumn()

void AMatrixDense::multiplyColumn ( const VectorDouble vec)
overridevirtual

Multiply a Matrix column-wise

Reimplemented from AMatrix.

◆ multiplyRow()

void AMatrixDense::multiplyRow ( const VectorDouble vec)
overridevirtual

Multiply a Matrix row-wise

Reimplemented from AMatrix.

◆ operator=()

AMatrixDense & AMatrixDense::operator= ( const AMatrixDense r)

◆ prodMatMatInPlace()

void AMatrixDense::prodMatMatInPlace ( const AMatrix x,
const AMatrix y,
bool  transposeX = false,
bool  transposeY = false 
)
overridevirtual

Multiply a matrix by another and stored in 'this'

Reimplemented from AMatrix.

◆ prodMatVec()

VectorDouble AMatrixDense::prodMatVec ( const VectorDouble x,
bool  transpose = false 
) const
overridevirtual

Perform 'this' * 'vec'

Reimplemented from AMatrix.

◆ prodNormMatInPlace()

void AMatrixDense::prodNormMatInPlace ( const AMatrixDense a,
const VectorDouble vec = VectorDouble(),
bool  transpose = false 
)
virtual

Product 't(A)' %*% ['vec'] %*% 'A' or 'A' %*% ['vec'] %*% 't(A)' stored in 'this'

Product 't(A)' %*% ['vec'] %*% 'A' or 'A' %*% ['vec'] %*% 't(A)' stored in 'this'

Parameters
aInput matrix
vecInput vector
transposeWhen True, the input Matrix is transposed

◆ prodNormMatMatInPlace()

void AMatrixDense::prodNormMatMatInPlace ( const AMatrixDense a,
const AMatrixDense m,
bool  transpose = false 
)
virtual

Product 't(A)' %*% 'M' %*% 'A' or 'A' %*% 'M' %*% 't(A)' stored in 'this'

Product of matrices: 'a' * 'm' (possibly transposed) stored in 'this'

Parameters
aFirst input matrix
mSecond input matrix
transposeTrue if 'm' should be transposed beforehand
Note
: 'a' and 'm' may NOT coincide with 'this'

◆ prodScalar()

void AMatrixDense::prodScalar ( double  v)
overridevirtual

Multiply each matrix component by a value

Reimplemented from AMatrix.

◆ prodVecMat()

VectorDouble AMatrixDense::prodVecMat ( const VectorDouble x,
bool  transpose = false 
) const
overridevirtual

Perform 'vec' * 'this'

Reimplemented from AMatrix.

◆ setColumn()

void AMatrixDense::setColumn ( int  icol,
const VectorDouble tab 
)
overridevirtual

Set the contents of a Column

Reimplemented from AMatrix.

◆ setDiagonal()

void AMatrixDense::setDiagonal ( const VectorDouble tab)
overridevirtual

Set the contents of the (main) Diagonal

Reimplemented from AMatrix.

◆ setDiagonalToConstant()

void AMatrixDense::setDiagonalToConstant ( double  value = 1.)
overridevirtual

Set the contents of the (main) Diagonal to a constant value

Reimplemented from AMatrix.

◆ setRow()

void AMatrixDense::setRow ( int  irow,
const VectorDouble tab 
)
overridevirtual

Set the contents of a Row

Reimplemented from AMatrix.

◆ setValue()

void AMatrixDense::setValue ( int  irow,
int  icol,
double  value,
bool  flagCheck = false 
)
overridevirtual

Set the value for in a matrix cell

Implements AMatrix.

◆ updValue()

void AMatrixDense::updValue ( int  irow,
int  icol,
const EOperator &  oper,
double  value,
bool  flagCheck = false 
)
overridevirtual

Update the contents of a matrix cell

Implements AMatrix.


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