template<class Element>
class TMatrixTSparse< Element >

Template class of a general sparse matrix in the Harwell-Boeing format

Besides the usual shape/size decsriptors of a matrix like fNrows, fRowLwb,fNcols and fColLwb, we also store a row index, fRowIndex and column index, fColIndex only for those elements unequal zero:

fRowIndex[0,..,fNrows]:    Stores for each row the index range of
                           the elements in the data and column array
fColIndex[0,..,fNelems-1]: Stores the column number for each data
                           element != 0

As an example how to access all sparse data elements:

for (Int_t irow = 0; irow < this->fNrows; irow++) {
  const Int_t sIndex = fRowIndex[irow];
  const Int_t eIndex = fRowIndex[irow+1];
  for (Int_t index = sIndex; index < eIndex; index++) {
    const Int_t icol = fColIndex[index];
    const Element data = fElements[index];
    printf("data(%d,%d) = %.4e\n",irow+this->fRowLwb,icol+
                                              this->fColLwb,data);
  }
}

When checking whether sparse matrices are compatible (like in an assigment !), not only the shape parameters are compared but also the sparse structure through fRowIndex and fColIndex .

Several methods exist to fill a sparse matrix with data entries. Most are the same like for dense matrices but some care has to be taken with regard to performance. In the constructor, always the shape of the matrix has to be specified in some form . Data can be entered through the following methods :

constructor
TMatrixTSparse(Int_t row_lwb,Int_t row_upb,Int_t dol_lwb,

Int_t col_upb,Int_t nr_nonzeros,

Int_t *row, Int_t *col,Element *data);
```
It uses SetMatrixArray(..), see below
```
copy constructors
SetMatrixArray(Int_t nr,Int_t *irow,Int_t *icol,Element *data) where it is expected that the irow,icol and data array contain nr entries . Only the entries with non-zero data[i] value are inserted. Be aware that the input data array will be modified inside the routine for doing the necessary sorting of indices !
TMatrixTSparse a(n,m); for(....) { a(i,j) = .... This is a very flexible method but expensive :
- if no entry for slot (i,j) is found in the sparse index table it will be entered, which involves some memory management !
- before invoking this method in a loop it is smart to first set the index table through a call to SetSparseIndex(..)
SetSub(Int_t row_lwb,Int_t col_lwb,const TMatrixTBase &source) the matrix to be inserted at position (row_lwb,col_lwb) can be both dense or sparse .

Definition at line 36 of file TMatrixTSparse.h.

Public Types
enum	EMatrixCreatorsOp1 { kZero, kUnit, kTransposed, kAtA }

enum	EMatrixCreatorsOp2 { kMult, kMultTranspose, kPlus, kMinus }

Public Member Functions
	TMatrixTSparse ()

	TMatrixTSparse (const TMatrixT< Element > &a, EMatrixCreatorsOp2 op, const TMatrixTSparse< Element > &b)
	Create a matrix applying a specific operation to two prototypes. More...

	TMatrixTSparse (const TMatrixT< Element > &another)

	TMatrixTSparse (const TMatrixTSparse< Element > &a, EMatrixCreatorsOp2 op, const TMatrixT< Element > &b)
	Create a matrix applying a specific operation to two prototypes. More...

	TMatrixTSparse (const TMatrixTSparse< Element > &a, EMatrixCreatorsOp2 op, const TMatrixTSparse< Element > &b)
	Create a matrix applying a specific operation to two prototypes. More...

	TMatrixTSparse (const TMatrixTSparse< Element > &another)

	TMatrixTSparse (EMatrixCreatorsOp1 op, const TMatrixTSparse< Element > &prototype)
	Create a matrix applying a specific operation to the prototype. More...

	TMatrixTSparse (Int_t nrows, Int_t ncols)
	Space is allocated for row/column indices and data, but the sparse structure information has still to be set ! More...

	TMatrixTSparse (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb)
	Space is allocated for row/column indices and data, but the sparse structure information has still to be set ! More...

	TMatrixTSparse (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb, Int_t nr_nonzeros, Int_t row, Int_t col, Element *data)
	Space is allocated for row/column indices and data. More...

virtual	~TMatrixTSparse ()

TClass *	Class ()

virtual void	Clear (Option_t *="")

virtual Element	ColNorm () const
	Column matrix norm, MAX{ SUM{ \|M(i,j)\|, over i}, over j}. More...

virtual void	ExtractRow (Int_t row, Int_t col, Element *v, Int_t n=-1) const
	Store in array v, n matrix elements of row rown starting at column coln. More...

virtual Int_t *	GetColIndexArray ()

virtual const Int_t *	GetColIndexArray () const

virtual void	GetMatrix2Array (Element data, Option_t ="") const
	Copy matrix data to array . It is assumed that array is of size >= fNelems. More...

virtual Element *	GetMatrixArray ()

virtual const Element *	GetMatrixArray () const

virtual Int_t *	GetRowIndexArray ()

virtual const Int_t *	GetRowIndexArray () const

TMatrixTSparse< Element >	GetSub (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb, Option_t *option="S") const

virtual TMatrixTBase< Element > &	GetSub (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb, TMatrixTBase< Element > &target, Option_t *option="S") const
	Get submatrix [row_lwb..row_upb][col_lwb..col_upb]; The indexing range of the returned matrix depends on the argument option: More...

virtual TMatrixTBase< Element > &	InsertRow (Int_t row, Int_t col, const Element *v, Int_t n=-1)
	Insert in row rown, n elements of array v at column coln. More...

virtual Bool_t	IsSymmetric () const

void	Mult (const TMatrixTSparse< Element > &a, const TMatrixTSparse< Element > &b)

virtual Int_t	NonZeros () const

virtual TMatrixTBase< Element > &	NormByDiag (const TVectorT< Element > &, Option_t *)

Element &	operator() (Int_t rown, Int_t coln)

Element	operator() (Int_t rown, Int_t coln) const

TMatrixTSparse< Element > &	operator*= (const TMatrixT< Element > &source)

TMatrixTSparse< Element > &	operator*= (const TMatrixTSparse< Element > &source)

TMatrixTSparse< Element > &	operator*= (Element val)
	Multiply every element of the matrix with val. More...

TMatrixTSparse< Element > &	operator+= (const TMatrixT< Element > &source)

TMatrixTSparse< Element > &	operator+= (const TMatrixTSparse< Element > &source)

TMatrixTSparse< Element > &	operator+= (Element val)
	Add val to every element of the matrix. More...

TMatrixTSparse< Element > &	operator-= (const TMatrixT< Element > &source)

TMatrixTSparse< Element > &	operator-= (const TMatrixTSparse< Element > &source)

TMatrixTSparse< Element > &	operator-= (Element val)
	Subtract val from every element of the matrix. More...

TMatrixTSparse< Element > &	operator= (const TMatrixT< Element > &source)
	Notice that the sparsity of the matrix is NOT changed : its fRowIndex/fColIndex are used ! More...

TMatrixTSparse< Element > &	operator= (const TMatrixTSparse< Element > &source)
	Notice that the sparsity of the matrix is NOT changed : its fRowIndex/fColIndex are used ! More...

TMatrixTSparse< Element > &	operator= (Element val)
	Assign val to every element of the matrix. More...

TMatrixTSparseRow< Element >	operator[] (Int_t rown)

const TMatrixTSparseRow_const< Element >	operator[] (Int_t rown) const

virtual TMatrixTBase< Element > &	Randomize (Element alpha, Element beta, Double_t &seed)
	randomize matrix element values More...

virtual TMatrixTSparse< Element > &	RandomizePD (Element alpha, Element beta, Double_t &seed)
	randomize matrix element values but keep matrix symmetric positive definite More...

TMatrixTBase< Element > &	ResizeTo (const TMatrixTSparse< Element > &m)

virtual TMatrixTBase< Element > &	ResizeTo (Int_t nrows, Int_t ncols, Int_t nr_nonzeros=-1)
	Set size of the matrix to nrows x ncols with nr_nonzeros non-zero entries if nr_nonzeros > 0 . More...

virtual TMatrixTBase< Element > &	ResizeTo (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb, Int_t nr_nonzeros=-1)
	Set size of the matrix to [row_lwb:row_upb] x [col_lwb:col_upb] with nr_nonzeros non-zero entries if nr_nonzeros > 0 . More...

virtual Element	RowNorm () const
	Row matrix norm, MAX{ SUM{ \|M(i,j)\|, over j}, over i}. More...

virtual TMatrixTBase< Element > &	SetColIndexArray (Int_t *data)

virtual TMatrixTBase< Element > &	SetMatrixArray (const Element data, Option_t ="")

virtual TMatrixTBase< Element > &	SetMatrixArray (Int_t nr_nonzeros, Int_t irow, Int_t icol, Element *data)
	Copy nr elements from row/col index and data array to matrix . More...

virtual TMatrixTBase< Element > &	SetRowIndexArray (Int_t *data)

TMatrixTSparse< Element > &	SetSparseIndex (const TMatrixTBase< Element > &another)
	Use non-zero data of matrix source to set the sparse structure. More...

TMatrixTSparse< Element > &	SetSparseIndex (Int_t nelem_new)
	Increase/decrease the number of non-zero elements to nelems_new. More...

TMatrixTSparse< Element > &	SetSparseIndexAB (const TMatrixT< Element > &a, const TMatrixTSparse< Element > &b)
	Set the row/column indices to the "sum" of matrices a and b It is checked that enough space has been allocated. More...

TMatrixTSparse< Element > &	SetSparseIndexAB (const TMatrixTSparse< Element > &a, const TMatrixT< Element > &b)

TMatrixTSparse< Element > &	SetSparseIndexAB (const TMatrixTSparse< Element > &a, const TMatrixTSparse< Element > &b)
	Set the row/column indices to the "sum" of matrices a and b It is checked that enough space has been allocated. More...

virtual TMatrixTBase< Element > &	SetSub (Int_t row_lwb, Int_t col_lwb, const TMatrixTBase< Element > &source)
	Insert matrix source starting at [row_lwb][col_lwb], thereby overwriting the part [row_lwb..row_lwb+nrows_source-1][col_lwb..col_lwb+ncols_source-1];. More...

TMatrixTSparse< Element > &	T ()

TMatrixTSparse< Element > &	Transpose (const TMatrixTSparse< Element > &source)
	Transpose a matrix. More...

virtual TMatrixTBase< Element > &	UnitMatrix ()
	Make a unit matrix (matrix need not be a square one). More...

const TMatrixTSparse< Element > &	Use (const TMatrixTSparse< Element > &a) const

const TMatrixTSparse< Element > &	Use (Int_t nrows, Int_t ncols, Int_t nr_nonzeros, const Int_t pRowIndex, const Int_t pColIndex, const Element *pData) const

TMatrixTSparse< Element > &	Use (Int_t nrows, Int_t ncols, Int_t nr_nonzeros, Int_t pRowIndex, Int_t pColIndex, Element *pData)

const TMatrixTSparse< Element > &	Use (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb, Int_t nr_nonzeros, const Int_t pRowIndex, const Int_t pColIndex, const Element *pData) const

TMatrixTSparse< Element > &	Use (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb, Int_t nr_nonzeros, Int_t pRowIndex, Int_t pColIndex, Element *pData)

TMatrixTSparse< Element > &	Use (TMatrixTSparse< Element > &a)

virtual TMatrixTBase< Element > &	Zero ()

Protected Member Functions
void	Allocate (Int_t nrows, Int_t ncols, Int_t row_lwb=0, Int_t col_lwb=0, Int_t init=0, Int_t nr_nonzeros=0)
	Allocate new matrix. More...

void	AMinusB (const TMatrixT< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)
	General matrix subtraction. More...

void	AMinusB (const TMatrixTSparse< Element > &a, const TMatrixT< Element > &b, Int_t constr=0)
	General matrix subtraction. More...

void	AMinusB (const TMatrixTSparse< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)
	General matrix subtraction. More...

void	AMultB (const TMatrixT< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)

void	AMultB (const TMatrixTSparse< Element > &a, const TMatrixT< Element > &b, Int_t constr=0)

void	AMultB (const TMatrixTSparse< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)

void	AMultBt (const TMatrixT< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)
	General matrix multiplication. More...

void	AMultBt (const TMatrixTSparse< Element > &a, const TMatrixT< Element > &b, Int_t constr=0)
	General matrix multiplication. More...

void	AMultBt (const TMatrixTSparse< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)
	General matrix multiplication. More...

void	APlusB (const TMatrixT< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)

void	APlusB (const TMatrixTSparse< Element > &a, const TMatrixT< Element > &b, Int_t constr=0)
	General matrix addition. More...

void	APlusB (const TMatrixTSparse< Element > &a, const TMatrixTSparse< Element > &b, Int_t constr=0)
	General matrix addition. More...

Protected Attributes
Int_t *	fColIndex

Element *	fElements

Int_t *	fRowIndex

#include <TMatrixTSparse.h>

Member Enumeration Documentation

◆ EMatrixCreatorsOp1

template<class Element >

enum TMatrixTSparse::EMatrixCreatorsOp1

Enumerator
kZero
kUnit
kTransposed
kAtA

Definition at line 70 of file TMatrixTSparse.h.

◆ EMatrixCreatorsOp2

template<class Element >

enum TMatrixTSparse::EMatrixCreatorsOp2

Enumerator
kMult
kMultTranspose
kPlus
kMinus

Definition at line 71 of file TMatrixTSparse.h.

Constructor & Destructor Documentation

◆ TMatrixTSparse() [1/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse ( )

inline

Definition at line 73 of file TMatrixTSparse.h.

◆ TMatrixTSparse() [2/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse	(	Int_t	nrows,
		Int_t	ncols
	)

Space is allocated for row/column indices and data, but the sparse structure information has still to be set !

Definition at line 93 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [3/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse	(	Int_t	row_lwb,
		Int_t	row_upb,
		Int_t	col_lwb,
		Int_t	col_upb
	)

Space is allocated for row/column indices and data, but the sparse structure information has still to be set !

Definition at line 103 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [4/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse	(	Int_t	row_lwb,
		Int_t	row_upb,
		Int_t	col_lwb,
		Int_t	col_upb,
		Int_t	nr,
		Int_t *	row,
		Int_t *	col,
		Element *	data
	)

Space is allocated for row/column indices and data.

Sparse row/column index structure together with data is coming from the arrays, row, col and data, resp .

Definition at line 113 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [5/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse ( const TMatrixTSparse< Element > & another )

Definition at line 152 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [6/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse ( const TMatrixT< Element > & another )

Definition at line 165 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [7/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse	(	EMatrixCreatorsOp1	op,
		const TMatrixTSparse< Element > &	prototype
	)

Create a matrix applying a specific operation to the prototype.

Supported operations are: kZero, kUnit, kTransposed and kAtA

Definition at line 178 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [8/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse	(	const TMatrixTSparse< Element > &	a,
		EMatrixCreatorsOp2	op,
		const TMatrixTSparse< Element > &	b
	)

Create a matrix applying a specific operation to two prototypes.

Supported operations are: kMult (a*b), kMultTranspose (a*b'), kPlus (a+b), kMinus (a-b)

Definition at line 228 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [9/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse	(	const TMatrixTSparse< Element > &	a,
		EMatrixCreatorsOp2	op,
		const TMatrixT< Element > &	b
	)

Create a matrix applying a specific operation to two prototypes.

Supported operations are: kMult (a*b), kMultTranspose (a*b'), kPlus (a+b), kMinus (a-b)

Definition at line 260 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [10/10]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse	(	const TMatrixT< Element > &	a,
		EMatrixCreatorsOp2	op,
		const TMatrixTSparse< Element > &	b
	)

Create a matrix applying a specific operation to two prototypes.

Supported operations are: kMult (a*b), kMultTranspose (a*b'), kPlus (a+b), kMinus (a-b)

Definition at line 292 of file TMatrixTSparse.cxx.

◆ ~TMatrixTSparse()

template<class Element >

virtual TMatrixTSparse< Element >::~TMatrixTSparse ( )

inlinevirtual

Definition at line 86 of file TMatrixTSparse.h.

Member Function Documentation

◆ Allocate()

template<class Element >

void TMatrixTSparse< Element >::Allocate	(	Int_t	no_rows,
		Int_t	no_cols,
		Int_t	row_lwb = `0`,
		Int_t	col_lwb = `0`,
		Int_t	init = `0`,
		Int_t	nr_nonzeros = `0`
	)

protected

Allocate new matrix.

Arguments are number of rows, columns, row lowerbound (0 default) and column lowerbound (0 default), 0 initialization flag and number of non-zero elements (only relevant for sparse format).

Definition at line 325 of file TMatrixTSparse.cxx.

◆ AMinusB() [1/3]

template<class Element >

void TMatrixTSparse< Element >::AMinusB	(	const TMatrixT< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix subtraction.

Create a matrix C such that C = A - B. Note, matrix C is allocated for constr=1.

Definition at line 1088 of file TMatrixTSparse.cxx.

◆ AMinusB() [2/3]

template<class Element >

void TMatrixTSparse< Element >::AMinusB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixT< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix subtraction.

Create a matrix C such that C = A - B. Note, matrix C is allocated for constr=1.

Definition at line 1017 of file TMatrixTSparse.cxx.

◆ AMinusB() [3/3]

template<class Element >

void TMatrixTSparse< Element >::AMinusB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix subtraction.

Create a matrix C such that C = A - B. Note, matrix C is allocated for constr=1.

Definition at line 935 of file TMatrixTSparse.cxx.

◆ AMultB() [1/3]

template<class Element >

void TMatrixTSparse< Element >::AMultB	(	const TMatrixT< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

inlineprotected

Definition at line 53 of file TMatrixTSparse.h.

◆ AMultB() [2/3]

template<class Element >

void TMatrixTSparse< Element >::AMultB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixT< Element > &	b,
		Int_t	constr = `0`
	)

inlineprotected

Definition at line 50 of file TMatrixTSparse.h.

◆ AMultB() [3/3]

template<class Element >

void TMatrixTSparse< Element >::AMultB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

inlineprotected

Definition at line 48 of file TMatrixTSparse.h.

◆ AMultBt() [1/3]

template<class Element >

void TMatrixTSparse< Element >::AMultBt	(	const TMatrixT< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix multiplication.

Create a matrix C such that C = A * B'. Note, matrix C is allocated for constr=1.

Definition at line 690 of file TMatrixTSparse.cxx.

◆ AMultBt() [2/3]

template<class Element >

void TMatrixTSparse< Element >::AMultBt	(	const TMatrixTSparse< Element > &	a,
		const TMatrixT< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix multiplication.

Create a matrix C such that C = A * B'. Note, matrix C is allocated for constr=1.

Definition at line 599 of file TMatrixTSparse.cxx.

◆ AMultBt() [3/3]

template<class Element >

void TMatrixTSparse< Element >::AMultBt	(	const TMatrixTSparse< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix multiplication.

Create a matrix C such that C = A * B'. Note, matrix C is allocated for constr=1.

Definition at line 491 of file TMatrixTSparse.cxx.

◆ APlusB() [1/3]

template<class Element >

void TMatrixTSparse< Element >::APlusB	(	const TMatrixT< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

inlineprotected

Definition at line 62 of file TMatrixTSparse.h.

◆ APlusB() [2/3]

template<class Element >

void TMatrixTSparse< Element >::APlusB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixT< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix addition.

Create a matrix C such that C = A + B. Note, matrix C is allocated for constr=1.

Definition at line 864 of file TMatrixTSparse.cxx.

◆ APlusB() [3/3]

template<class Element >

void TMatrixTSparse< Element >::APlusB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixTSparse< Element > &	b,
		Int_t	constr = `0`
	)

protected

General matrix addition.

Create a matrix C such that C = A + B. Note, matrix C is allocated for constr=1.

Definition at line 782 of file TMatrixTSparse.cxx.

◆ Class()

TClass * TMatrixTSparse< double >::Class ( )

◆ Clear()

template<class Element >

virtual void TMatrixTSparse< Element >::Clear ( Option_t * = "" )

inlinevirtual

Definition at line 117 of file TMatrixTSparse.h.

◆ ColNorm()

template<class Element >

Element TMatrixTSparse< Element >::ColNorm

virtual

Column matrix norm, MAX{ SUM{ |M(i,j)|, over i}, over j}.

The norm is induced by the 1 vector norm.

Definition at line 2129 of file TMatrixTSparse.cxx.

◆ ExtractRow()

template<class Element >

void TMatrixTSparse< Element >::ExtractRow	(	Int_t	row,
		Int_t	col,
		Element *	v,
		Int_t	n = `-1`
	)		const

virtual

Store in array v, n matrix elements of row rown starting at column coln.

Definition at line 450 of file TMatrixTSparse.cxx.

◆ GetColIndexArray() [1/2]

template<class Element >

Int_t * TMatrixTSparse< Element >::GetColIndexArray

inlinevirtual

Definition at line 221 of file TMatrixTSparse.h.

◆ GetColIndexArray() [2/2]

template<class Element >

const Int_t * TMatrixTSparse< Element >::GetColIndexArray

inlinevirtual

Definition at line 220 of file TMatrixTSparse.h.

◆ GetMatrix2Array()

template<class Element >

void TMatrixTSparse< Element >::GetMatrix2Array	(	Element *	data,
		Option_t *	= `""`
	)		const

virtual

Copy matrix data to array . It is assumed that array is of size >= fNelems.

Definition at line 1158 of file TMatrixTSparse.cxx.

◆ GetMatrixArray() [1/2]

template<class Element >

Element * TMatrixTSparse< Element >::GetMatrixArray

inlinevirtual

Definition at line 217 of file TMatrixTSparse.h.

◆ GetMatrixArray() [2/2]

template<class Element >

const Element * TMatrixTSparse< Element >::GetMatrixArray

inlinevirtual

Definition at line 216 of file TMatrixTSparse.h.

◆ GetRowIndexArray() [1/2]

template<class Element >

Int_t * TMatrixTSparse< Element >::GetRowIndexArray

inlinevirtual

Definition at line 219 of file TMatrixTSparse.h.

◆ GetRowIndexArray() [2/2]

template<class Element >

const Int_t * TMatrixTSparse< Element >::GetRowIndexArray

inlinevirtual

Definition at line 218 of file TMatrixTSparse.h.

◆ GetSub() [1/2]

template<class Element >

TMatrixTSparse< Element > TMatrixTSparse< Element >::GetSub	(	Int_t	row_lwb,
		Int_t	row_upb,
		Int_t	col_lwb,
		Int_t	col_upb,
		Option_t *	option = `"S"`
	)		const

inline

Definition at line 245 of file TMatrixTSparse.h.

◆ GetSub() [2/2]

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::GetSub	(	Int_t	row_lwb,
		Int_t	row_upb,
		Int_t	col_lwb,
		Int_t	col_upb,
		TMatrixTBase< Element > &	target,
		Option_t *	option = `"S"`
	)		const

virtual

Get submatrix [row_lwb..row_upb][col_lwb..col_upb]; The indexing range of the returned matrix depends on the argument option:

option == "S" : return [0..row_upb-row_lwb+1][0..col_upb-col_lwb+1] (default) else : return [row_lwb..row_upb][col_lwb..col_upb]

Definition at line 1751 of file TMatrixTSparse.cxx.

◆ InsertRow()

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::InsertRow	(	Int_t	row,
		Int_t	col,
		const Element *	v,
		Int_t	n = `-1`
	)

virtual

Insert in row rown, n elements of array v at column coln.

Definition at line 367 of file TMatrixTSparse.cxx.

◆ IsSymmetric()

template<class Element >

virtual Bool_t TMatrixTSparse< Element >::IsSymmetric ( ) const

inlinevirtual

Definition at line 147 of file TMatrixTSparse.h.

◆ Mult()

template<class Element >

void TMatrixTSparse< Element >::Mult	(	const TMatrixTSparse< Element > &	a,
		const TMatrixTSparse< Element > &	b
	)

inline

Definition at line 151 of file TMatrixTSparse.h.

◆ NonZeros()

template<class Element >

virtual Int_t TMatrixTSparse< Element >::NonZeros ( ) const

inlinevirtual

Definition at line 158 of file TMatrixTSparse.h.

◆ NormByDiag()

template<class Element >

virtual TMatrixTBase<Element>& TMatrixTSparse< Element >::NormByDiag	(	const TVectorT< Element > &	,
		Option_t *
	)

inlinevirtual

Definition at line 160 of file TMatrixTSparse.h.

◆ operator()() [1/2]

template<class Element >

Element & TMatrixTSparse< Element >::operator()	(	Int_t	rown,
		Int_t	coln
	)

Definition at line 2157 of file TMatrixTSparse.cxx.

◆ operator()() [2/2]

template<class Element >

Element TMatrixTSparse< Element >::operator()	(	Int_t	rown,
		Int_t	coln
	)		const

Definition at line 2201 of file TMatrixTSparse.cxx.

◆ operator*=() [1/3]

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::operator*= ( const TMatrixT< Element > & source )

inline

Definition at line 195 of file TMatrixTSparse.h.

◆ operator*=() [2/3]

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::operator*= ( const TMatrixTSparse< Element > & source )

inline

Definition at line 191 of file TMatrixTSparse.h.

◆ operator*=() [3/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::operator*= ( Element val )

Multiply every element of the matrix with val.

Definition at line 2340 of file TMatrixTSparse.cxx.

◆ operator+=() [1/3]

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::operator+= ( const TMatrixT< Element > & source )

inline

Definition at line 183 of file TMatrixTSparse.h.

◆ operator+=() [2/3]

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::operator+= ( const TMatrixTSparse< Element > & source )

inline

Definition at line 179 of file TMatrixTSparse.h.

◆ operator+=() [3/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::operator+= ( Element val )

Add val to every element of the matrix.

Definition at line 2308 of file TMatrixTSparse.cxx.

◆ operator-=() [1/3]

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::operator-= ( const TMatrixT< Element > & source )

inline

Definition at line 189 of file TMatrixTSparse.h.

◆ operator-=() [2/3]

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::operator-= ( const TMatrixTSparse< Element > & source )

inline

Definition at line 185 of file TMatrixTSparse.h.

◆ operator-=() [3/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::operator-= ( Element val )

Subtract val from every element of the matrix.

Definition at line 2324 of file TMatrixTSparse.cxx.

◆ operator=() [1/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::operator= ( const TMatrixT< Element > & source )

Notice that the sparsity of the matrix is NOT changed : its fRowIndex/fColIndex are used !

Definition at line 2256 of file TMatrixTSparse.cxx.

◆ operator=() [2/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::operator= ( const TMatrixTSparse< Element > & source )

Notice that the sparsity of the matrix is NOT changed : its fRowIndex/fColIndex are used !

Definition at line 2233 of file TMatrixTSparse.cxx.

◆ operator=() [3/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::operator= ( Element val )

Assign val to every element of the matrix.

Check that the row/col indices are set !

Definition at line 2287 of file TMatrixTSparse.cxx.

◆ operator[]() [1/2]

template<class Element >

TMatrixTSparseRow<Element> TMatrixTSparse< Element >::operator[] ( Int_t rown )

inline

Definition at line 169 of file TMatrixTSparse.h.

◆ operator[]() [2/2]

template<class Element >

const TMatrixTSparseRow_const<Element> TMatrixTSparse< Element >::operator[] ( Int_t rown ) const

inline

Definition at line 168 of file TMatrixTSparse.h.

◆ Randomize()

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::Randomize	(	Element	alpha,
		Element	beta,
		Double_t &	seed
	)

virtual

randomize matrix element values

Definition at line 2356 of file TMatrixTSparse.cxx.

◆ RandomizePD()

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::RandomizePD	(	Element	alpha,
		Element	beta,
		Double_t &	seed
	)

virtual

randomize matrix element values but keep matrix symmetric positive definite

Definition at line 2403 of file TMatrixTSparse.cxx.

◆ ResizeTo() [1/3]

template<class Element >

TMatrixTBase<Element>& TMatrixTSparse< Element >::ResizeTo ( const TMatrixTSparse< Element > & m )

inline

Definition at line 114 of file TMatrixTSparse.h.

◆ ResizeTo() [2/3]

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::ResizeTo	(	Int_t	nrows,
		Int_t	ncols,
		Int_t	nr_nonzeros = `-1`
	)

virtual

Set size of the matrix to nrows x ncols with nr_nonzeros non-zero entries if nr_nonzeros > 0 .

New dynamic elements are created, the overlapping part of the old ones are copied to the new structures, then the old elements are deleted.

Definition at line 1518 of file TMatrixTSparse.cxx.

◆ ResizeTo() [3/3]

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::ResizeTo	(	Int_t	row_lwb,
		Int_t	row_upb,
		Int_t	col_lwb,
		Int_t	col_upb,
		Int_t	nr_nonzeros = `-1`
	)

virtual

Set size of the matrix to [row_lwb:row_upb] x [col_lwb:col_upb] with nr_nonzeros non-zero entries if nr_nonzeros > 0 .

New dynamic elements are created, the overlapping part of the old ones are copied to the new structures, then the old elements are deleted.

Definition at line 1612 of file TMatrixTSparse.cxx.

◆ RowNorm()

template<class Element >

Element TMatrixTSparse< Element >::RowNorm

virtual

Row matrix norm, MAX{ SUM{ |M(i,j)|, over j}, over i}.

The norm is induced by the infinity vector norm.

Definition at line 2100 of file TMatrixTSparse.cxx.

◆ SetColIndexArray()

template<class Element >

virtual TMatrixTBase<Element>& TMatrixTSparse< Element >::SetColIndexArray ( Int_t * data )

inlinevirtual

Definition at line 96 of file TMatrixTSparse.h.

◆ SetMatrixArray() [1/2]

template<class Element >

virtual TMatrixTBase<Element>& TMatrixTSparse< Element >::SetMatrixArray	(	const Element *	data,
		Option_t *	= `""`
	)

inlinevirtual

Definition at line 106 of file TMatrixTSparse.h.

◆ SetMatrixArray() [2/2]

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::SetMatrixArray	(	Int_t	nr,
		Int_t *	row,
		Int_t *	col,
		Element *	data
	)

virtual

Copy nr elements from row/col index and data array to matrix .

It is assumed that arrays are of size >= nr Note that the input arrays are not passed as const since they will be modified !

Definition at line 1172 of file TMatrixTSparse.cxx.

◆ SetRowIndexArray()

template<class Element >

virtual TMatrixTBase<Element>& TMatrixTSparse< Element >::SetRowIndexArray ( Int_t * data )

inlinevirtual

Definition at line 95 of file TMatrixTSparse.h.

◆ SetSparseIndex() [1/2]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::SetSparseIndex ( const TMatrixTBase< Element > & another )

Use non-zero data of matrix source to set the sparse structure.

Definition at line 1296 of file TMatrixTSparse.cxx.

◆ SetSparseIndex() [2/2]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::SetSparseIndex ( Int_t nelem_new )

Increase/decrease the number of non-zero elements to nelems_new.

Definition at line 1262 of file TMatrixTSparse.cxx.

◆ SetSparseIndexAB() [1/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::SetSparseIndexAB	(	const TMatrixT< Element > &	a,
		const TMatrixTSparse< Element > &	b
	)

Set the row/column indices to the "sum" of matrices a and b It is checked that enough space has been allocated.

Definition at line 1433 of file TMatrixTSparse.cxx.

◆ SetSparseIndexAB() [2/3]

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::SetSparseIndexAB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixT< Element > &	b
	)

inline

Definition at line 102 of file TMatrixTSparse.h.

◆ SetSparseIndexAB() [3/3]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::SetSparseIndexAB	(	const TMatrixTSparse< Element > &	a,
		const TMatrixTSparse< Element > &	b
	)

Set the row/column indices to the "sum" of matrices a and b It is checked that enough space has been allocated.

Definition at line 1339 of file TMatrixTSparse.cxx.

◆ SetSub()

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::SetSub	(	Int_t	row_lwb,
		Int_t	col_lwb,
		const TMatrixTBase< Element > &	source
	)

virtual

Insert matrix source starting at [row_lwb][col_lwb], thereby overwriting the part [row_lwb..row_lwb+nrows_source-1][col_lwb..col_lwb+ncols_source-1];.

Definition at line 1851 of file TMatrixTSparse.cxx.

◆ T()

template<class Element >

TMatrixTSparse<Element>& TMatrixTSparse< Element >::T ( )

inline

Definition at line 149 of file TMatrixTSparse.h.

◆ Transpose()

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::Transpose ( const TMatrixTSparse< Element > & source )

Transpose a matrix.

Definition at line 1987 of file TMatrixTSparse.cxx.

◆ UnitMatrix()

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::UnitMatrix

virtual

Make a unit matrix (matrix need not be a square one).

Definition at line 2058 of file TMatrixTSparse.cxx.

◆ Use() [1/6]

template<class Element >

const TMatrixTSparse< Element > & TMatrixTSparse< Element >::Use ( const TMatrixTSparse< Element > & a ) const

inline

Definition at line 238 of file TMatrixTSparse.h.

◆ Use() [2/6]

template<class Element >

const TMatrixTSparse< Element > & TMatrixTSparse< Element >::Use	(	Int_t	nrows,
		Int_t	ncols,
		Int_t	nr_nonzeros,
		const Int_t *	pRowIndex,
		const Int_t *	pColIndex,
		const Element *	pData
	)		const

inline

Definition at line 228 of file TMatrixTSparse.h.

◆ Use() [3/6]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::Use	(	Int_t	nrows,
		Int_t	ncols,
		Int_t	nr_nonzeros,
		Int_t *	pRowIndex,
		Int_t *	pColIndex,
		Element *	pData
	)

inline

Definition at line 224 of file TMatrixTSparse.h.

◆ Use() [4/6]

template<class Element >

const TMatrixTSparse<Element>& TMatrixTSparse< Element >::Use	(	Int_t	row_lwb,
		Int_t	row_upb,
		Int_t	col_lwb,
		Int_t	col_upb,
		Int_t	nr_nonzeros,
		const Int_t *	pRowIndex,
		const Int_t *	pColIndex,
		const Element *	pData
	)		const

inline

Definition at line 128 of file TMatrixTSparse.h.

◆ Use() [5/6]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::Use	(	Int_t	row_lwb,
		Int_t	row_upb,
		Int_t	col_lwb,
		Int_t	col_upb,
		Int_t	nr_nonzeros,
		Int_t *	pRowIndex,
		Int_t *	pColIndex,
		Element *	pData
	)

Definition at line 1711 of file TMatrixTSparse.cxx.

◆ Use() [6/6]

template<class Element >

TMatrixTSparse< Element > & TMatrixTSparse< Element >::Use ( TMatrixTSparse< Element > & a )

inline

Definition at line 232 of file TMatrixTSparse.h.

◆ Zero()

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::Zero

virtual

Definition at line 2042 of file TMatrixTSparse.cxx.

Member Data Documentation

◆ fColIndex

template<class Element >

Int_t* TMatrixTSparse< Element >::fColIndex

protected

Definition at line 41 of file TMatrixTSparse.h.

◆ fElements

template<class Element >

Element* TMatrixTSparse< Element >::fElements

protected

Definition at line 42 of file TMatrixTSparse.h.

◆ fRowIndex

template<class Element >

Int_t* TMatrixTSparse< Element >::fRowIndex

protected

Definition at line 40 of file TMatrixTSparse.h.

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

math/matrix/inc/TMatrixDSparsefwd.h
math/matrix/inc/TMatrixTSparse.h
math/matrix/src/TMatrixTSparse.cxx

template<class Element> class TMatrixTSparse< Element >

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

◆ EMatrixCreatorsOp1

◆ EMatrixCreatorsOp2

Constructor & Destructor Documentation

◆ TMatrixTSparse() [1/10]

◆ TMatrixTSparse() [2/10]

◆ TMatrixTSparse() [3/10]

◆ TMatrixTSparse() [4/10]

◆ TMatrixTSparse() [5/10]

◆ TMatrixTSparse() [6/10]

◆ TMatrixTSparse() [7/10]

◆ TMatrixTSparse() [8/10]

◆ TMatrixTSparse() [9/10]

◆ TMatrixTSparse() [10/10]

◆ ~TMatrixTSparse()

Member Function Documentation

◆ Allocate()

◆ AMinusB() [1/3]

◆ AMinusB() [2/3]

◆ AMinusB() [3/3]

◆ AMultB() [1/3]

◆ AMultB() [2/3]

◆ AMultB() [3/3]

◆ AMultBt() [1/3]

◆ AMultBt() [2/3]

◆ AMultBt() [3/3]

◆ APlusB() [1/3]

◆ APlusB() [2/3]

◆ APlusB() [3/3]

◆ Class()

◆ Clear()

◆ ColNorm()

◆ ExtractRow()

◆ GetColIndexArray() [1/2]

◆ GetColIndexArray() [2/2]

◆ GetMatrix2Array()

◆ GetMatrixArray() [1/2]

◆ GetMatrixArray() [2/2]

◆ GetRowIndexArray() [1/2]

◆ GetRowIndexArray() [2/2]

◆ GetSub() [1/2]

◆ GetSub() [2/2]

◆ InsertRow()

◆ IsSymmetric()

◆ Mult()

◆ NonZeros()

◆ NormByDiag()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator*=() [3/3]

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator-=() [1/3]

◆ operator-=() [2/3]

◆ operator-=() [3/3]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Randomize()

◆ RandomizePD()

◆ ResizeTo() [1/3]

◆ ResizeTo() [2/3]

◆ ResizeTo() [3/3]

◆ RowNorm()

◆ SetColIndexArray()

◆ SetMatrixArray() [1/2]

◆ SetMatrixArray() [2/2]

◆ SetRowIndexArray()

◆ SetSparseIndex() [1/2]

◆ SetSparseIndex() [2/2]

template<class Element>
class TMatrixTSparse< Element >