#include <MatrixSquare.hpp>

Inheritance diagram for MatrixSquare:

Detailed Description

Square Matrix

Public Member Functions
	MatrixSquare (int nrow=0)

	MatrixSquare (const MatrixSquare &r)

	MatrixSquare (const AMatrix &m)

MatrixSquare &	operator= (const MatrixSquare &r)

virtual	~MatrixSquare ()

virtual double	determinant (void) const
	ICloneable interface.

bool	isSquare (bool printWhyNot=false) const override

bool	mustBeSymmetric () const override

int	getNSize () const

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

double	trace () const

void	innerMatrix (const MatrixSquare &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)

int	decomposeLU (MatrixSquare &tls, MatrixSquare &tus, double eps=EPSILON20)

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

	MatrixDense (const MatrixDense &r)

	MatrixDense (const AMatrix &r)

MatrixDense &	operator= (const MatrixDense &r)

virtual	~MatrixDense ()

bool	isDense () const override
	Cloneable interface.

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 MatrixDense &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).

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

virtual void	prodNormMatVecInPlace (const MatrixDense &a, const VectorDouble &vec=VectorDouble(), bool transpose=false)

VectorDouble	getEigenValues () const

const MatrixSquare *	getEigenVectors () const

int	invert2 (MatrixDense &res) const

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.

MatrixDense	compressMatLC (const MatrixDense &matLC, bool transpose=false)
	Perform the compressing product, according to 'transpose'.

void	addRow (int nrow_added=1)

void	addColumn (int ncolumn_added=1)

constvect	getViewOnColumn (int icol) const

vect	getViewOnColumnModify (int icol)

Eigen::Map< const Eigen::MatrixXd >	getEigenMat () const

Eigen::Map< Eigen::MatrixXd >	getEigenMat ()

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.

virtual void	resetFromArray (int nrows, int ncols, const double *tab, bool byCol=true)
	Reset the matrix from an array of double values.

virtual void	resetFromVD (int nrows, int ncols, const VectorDouble &tab, bool byCol=true)
	Reset the matrix from a vector of double values.

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable.

void	clear ()

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)

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	getNColDefined () const

int	getNRowDefined () const

VectorDouble	getColumnByRowRange (int icol, int rowFrom, int rowTo) 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	dumpStatistics (const String &title) 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.

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)

virtual bool	needToReset (int nrows, int ncols)

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

Static Public Member Functions
static MatrixSquare *	createFromVVD (const VectorVectorDouble &X)

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

Static Public Member Functions inherited from MatrixDense
static MatrixDense *	create (const MatrixDense *mat)

static MatrixDense *	create (int nrow, int ncol)

static MatrixDense *	createFromVVD (const VectorVectorDouble &X)

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

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

static MatrixDense *	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'.

static void	sum (const MatrixDense mat1, const MatrixDense mat2, MatrixDense *mat3)

Public Attributes
	DECLARE_TOTL
	Has a specific implementation in the Target language.

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

Constructor & Destructor Documentation

◆ MatrixSquare() [1/3]

MatrixSquare::MatrixSquare ( int nrow = 0 )

◆ MatrixSquare() [2/3]

MatrixSquare::MatrixSquare ( const MatrixSquare & r )

◆ MatrixSquare() [3/3]

MatrixSquare::MatrixSquare ( const AMatrix & m )

◆ ~MatrixSquare()

MatrixSquare::~MatrixSquare ( )

virtual

Member Function Documentation

◆ createFromVD()

MatrixSquare * MatrixSquare::createFromVD	(	const VectorDouble &	X,
		int	nrow,
		bool	byCol = `false`,
		bool	invertColumnOrder = `false`
	)

static

◆ createFromVVD()

MatrixSquare * MatrixSquare::createFromVVD ( const VectorVectorDouble & X )

static

Converts a VectorVectorDouble into a Matrix Note: the input argument is stored by row (if coming from [] specification)

Parameters

X	Input VectorVectorDouble argument

Returns: The returned square matrix

Remarks: : the matrix is transposed implicitly while reading

◆ decomposeLU()

int MatrixSquare::decomposeLU	(	MatrixSquare &	tls,
		MatrixSquare &	tus,
		double	eps = `EPSILON20`
	)

LU Decomposition of a square matrix (not necessarily symmetric)

Parameters

tls	Output square matrix containing lower triangle (stored columnwise)
tus	Output square matrix containing upper triangle (stored linewise)
eps	Tolerance

Remarks: The output matrices 'tus' and 'tls' must be dimensioned beforehand

◆ determinant()

double MatrixSquare::determinant ( void ) const

virtual

ICloneable interface.

Interface for AMatrix

◆ divideDiagByVector()

void MatrixSquare::divideDiagByVector ( const VectorDouble & diag )

Divide the diagonal by a vector

◆ getNSize()

int MatrixSquare::getNSize ( ) const

inline

Returns the size of the matrix (nrows=ncols)

◆ innerMatrix()

void MatrixSquare::innerMatrix	(	const MatrixSquare &	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 MatrixSquare::isSquare ( bool printWhyNot = false ) const

inlineoverridevirtual

Check if the matrix is (non empty) square

Reimplemented from AMatrix.

◆ mustBeSymmetric()

bool MatrixSquare::mustBeSymmetric ( ) const

inlineoverridevirtual

Say if the matrix must be symmetric

Reimplemented from MatrixDense.

Reimplemented in MatrixSymmetric.

◆ normVec()

double MatrixSquare::normVec ( const VectorDouble & vec )

◆ operator=()

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

◆ prodByDiagInPlace()

void MatrixSquare::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 MatrixSquare::prodDiagByVector ( const VectorDouble & diag )

Multiply the diagonal by a vector

◆ resetFromVVD()

void MatrixSquare::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 MatrixSymmetric.

◆ trace()

double MatrixSquare::trace ( ) const

Member Data Documentation

◆ DECLARE_TOTL

MatrixSquare::DECLARE_TOTL

Has a specific implementation in the Target language.

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

include/Matrix/MatrixSquare.hpp
src/Matrix/MatrixSquare.cpp

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Constructor & Destructor Documentation

◆ MatrixSquare() [1/3]

◆ MatrixSquare() [2/3]

◆ MatrixSquare() [3/3]

◆ ~MatrixSquare()

Member Function Documentation

◆ createFromVD()

◆ createFromVVD()

◆ decomposeLU()

◆ determinant()

◆ divideDiagByVector()

◆ getNSize()

◆ innerMatrix()

◆ isSquare()

◆ mustBeSymmetric()

◆ normVec()

◆ operator=()

◆ prodByDiagInPlace()

◆ prodDiagByVector()

◆ resetFromVVD()

◆ trace()

Member Data Documentation

◆ DECLARE_TOTL