#include <AMatrixSquare.hpp>

Inheritance diagram for AMatrixSquare:

Detailed Description

Square Matrix

Public Member Functions
	AMatrixSquare (int nrow=0)

	AMatrixSquare (const AMatrixSquare &r)

	AMatrixSquare (const AMatrix &m)

AMatrixSquare &	operator= (const AMatrixSquare &r)

virtual	~AMatrixSquare ()

virtual double	determinant (void) const
	Interface for AMatrix. More...

bool	isSquare (bool printWhyNot=false) const override

int	getNSize () const

void	resetFromVVD (const VectorVectorDouble &tab, bool byCol=true) override
	Reset the matrix from an array of double values. More...

double	trace () const

void	innerMatrix (const AMatrixSquare &x, const AMatrix &r1, const AMatrix &r2)

void	prodDiagByVector (const VectorDouble &diag)

void	divideDiagByVector (const VectorDouble &diag)

void	prodByDiagInPlace (int mode, const VectorDouble &c)

double	normVec (const VectorDouble &vec)

Public Member Functions inherited from MatrixRectangular
	MatrixRectangular (int nrow=0, int ncol=0)

	MatrixRectangular (const MatrixRectangular &r)

	MatrixRectangular (const AMatrix &m)

MatrixRectangular &	operator= (const MatrixRectangular &r)

virtual	~MatrixRectangular ()

bool	mustBeSymmetric () const override
	Cloneable interface. More...

void	unsample (const AMatrix *A, const VectorInt &rowFetch, const VectorInt &colFetch, bool flagInvertRow=false, bool flagInvertCol=false)
	Set the values contained in 'A' into the current matrix. More...

void	addRow (int nrow_added=1)

void	addColumn (int ncolumn_added=1)

Public Member Functions inherited from AMatrixDense
	AMatrixDense (int nrow=0, int ncol=0)

	AMatrixDense (const AMatrixDense &r)

	AMatrixDense (const AMatrix &m)

AMatrixDense &	operator= (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, bool flagCheck=false) override

virtual void	setRow (int irow, const VectorDouble &tab, bool flagCheck=false) override

virtual void	setDiagonal (const VectorDouble &tab, bool flagCheck=false) 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

constvect	getColumnPtr (int icol) const

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	prodNormMatVecInPlace (const AMatrixDense &a, const VectorDouble &vec=VectorDouble(), bool transpose=false)

VectorDouble	getEigenValues () const

const MatrixSquareGeneral *	getEigenVectors () const

constvect	getViewOnColumn (int icol) const

const Eigen::MatrixXd *	getTab () const

Public Member Functions inherited from AMatrix
	AMatrix (int nrow=0, int ncol=0)

	AMatrix (const AMatrix &m)

AMatrix &	operator= (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 String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable. More...

virtual bool	isValid (int irow, int icol, bool printWhyNot=false) const

virtual bool	isIdentity (bool printWhyNot=false) const

virtual bool	isSymmetric (double eps=EPSILON10, bool printWhyNot=false) const

virtual void	transposeInPlace ()

virtual AMatrix *	transpose () 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	prodNormMatVecInPlace (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) const

void	prodMatVecInPlace (const VectorDouble &x, VectorDouble &y, bool transpose=false) const

int	prodMatVecInPlace (const constvect x, vect 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)

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 &validRows, const VectorInt &validCols)

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 val3=1., const AMatrix *mat3=nullptr)
	Perfom the algebraic equation this = val1 * mat1 + val2 * mat2 + val3 * mat3. More...

virtual int	addProdMatVecInPlace (const constvect x, vect y, bool transpose=false) const

double	operator() (int row, int col) const

double &	operator() (int row, int col)

Public Member Functions inherited from AStringable
	AStringable ()

	AStringable (const AStringable &r)

AStringable &	operator= (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 ICloneable *	clone () const =0

Additional Inherited Members
Static Public Member Functions inherited from MatrixRectangular
static MatrixRectangular *	create (const MatrixRectangular *mat)

static MatrixRectangular *	create (int nrow, int ncol)

static MatrixRectangular *	createFromVVD (const VectorVectorDouble &X)

static MatrixRectangular *	createFromVD (const VectorDouble &X, int nrow, int ncol, bool byCol=false, bool invertColumnOrder=false)

static MatrixRectangular *	glue (const AMatrix A1, const AMatrix A2, bool flagShiftRow, bool flagShiftCol)

static MatrixRectangular *	sample (const AMatrix *A, const VectorInt &rowKeep=VectorInt(), const VectorInt &colKeep=VectorInt(), bool flagInvertRow=false, bool flagInvertCol=false)
	Create an output Rectangular Matrix by selecting some rows and columns of the Input matrix 'A'. More...

Public Attributes inherited from MatrixRectangular
	DECLARE_TOTL
	Has a specific implementation in the Target language. More...

Constructor & Destructor Documentation

◆ AMatrixSquare() [1/3]

AMatrixSquare::AMatrixSquare ( int nrow = 0 )

◆ AMatrixSquare() [2/3]

AMatrixSquare::AMatrixSquare ( const AMatrixSquare & r )

◆ AMatrixSquare() [3/3]

AMatrixSquare::AMatrixSquare ( const AMatrix & m )

◆ ~AMatrixSquare()

AMatrixSquare::~AMatrixSquare ( )

virtual

Member Function Documentation

◆ determinant()

double AMatrixSquare::determinant ( void ) const

virtual

Interface for AMatrix.

◆ divideDiagByVector()

void AMatrixSquare::divideDiagByVector ( const VectorDouble & diag )

Divide the diagonal by a vector

◆ getNSize()

int AMatrixSquare::getNSize ( ) const

inline

Returns the size of the matrix (nrows=ncols)

◆ innerMatrix()

void AMatrixSquare::innerMatrix	(	const AMatrixSquare &	x,
		const AMatrix &	r1,
		const AMatrix &	r2
	)

Perform inner product

Perform the product: this = t(R1) %*% X %*% R2 + t(R2) %*% X %*% R1

Parameters

x	Square matrix
r1	Left Hand Matrix
r2	Right Hand Matrix

Remarks: The number of rows of Y must be equal to the dimension of X; The output matrix is square with dimension equal to the number of columns of Y

◆ isSquare()

bool AMatrixSquare::isSquare ( bool printWhyNot = false ) const

inlineoverridevirtual

Check if the matrix is (non empty) square

Reimplemented from AMatrix.

◆ normVec()

double AMatrixSquare::normVec ( const VectorDouble & vec )

◆ operator=()

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

◆ prodByDiagInPlace()

void AMatrixSquare::prodByDiagInPlace	(	int	mode,
		const VectorDouble &	c
	)

Multiply by a Diagonal matrix provided as VectorDouble (in place)

Performs the 'this' %*% diag(c) where c is a vector

Parameters

[in]	mode	0: c as is; 1: sqrt(c); 2: 1/c; 3: 1/sqrt(c)
[in]	c	vector

◆ prodDiagByVector()

void AMatrixSquare::prodDiagByVector ( const VectorDouble & diag )

Multiply the diagonal by a vector

◆ resetFromVVD()

void AMatrixSquare::resetFromVVD	(	const VectorVectorDouble &	tab,
		bool	byCol = `true`
	)

overridevirtual

Reset the matrix from an array of double values.

Parameters

tab	The array of values
byCol	True if values are column-major in the array

Reimplemented from AMatrix.

Reimplemented in MatrixSquareSymmetric.

◆ trace()

double AMatrixSquare::trace ( ) const

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

include/Matrix/AMatrixSquare.hpp
src/Matrix/AMatrixSquare.cpp

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ AMatrixSquare() [1/3]

◆ AMatrixSquare() [2/3]

◆ AMatrixSquare() [3/3]

◆ ~AMatrixSquare()

Member Function Documentation

◆ determinant()

◆ divideDiagByVector()

◆ getNSize()

◆ innerMatrix()

◆ isSquare()

◆ normVec()

◆ operator=()

◆ prodByDiagInPlace()

◆ prodDiagByVector()

◆ resetFromVVD()

◆ trace()