template<class Element>
class TMatrixTSparse< Element >

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

Besides the usual shape/size descriptors 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 assignment !), 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 from COO matrix format
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);

TMatrixTSparse::TMatrixTSparse
TMatrixTSparse()
Definition TMatrixTSparse.h:83

It uses SetMatrixArray(..), see below
constructor from Harwell-Boeing (CSR) matrix format
TMatrixTSparse(Int_t row_lwb,Int_t row_upb,Int_t dol_lwb,

Int_t col_upb,

Int_t *rowptr, Int_t *col,Element *data);

It copies input arrays into matrix .
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 !
SetMatrixArray(Int_t nr,Int_t nrows,Int_t ncols,Int_t *irow, Int_t *icol,Element *data) where it is expected that the irow, icol and data array contain nr entries . It allows to reshape the matrix according to nrows and ncols. 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 Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

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.

	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.

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

	TMatrixTSparse (const TMatrixTSparse< Element > &another)

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

	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 !

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

	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.

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

	~TMatrixTSparse () override

TClass *	Class ()

void	Clear (Option_t *="") override

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

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

const Int_t *	GetColIndexArray () const override

Int_t *	GetColIndexArray () override

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

const Element *	GetMatrixArray () const override

Element *	GetMatrixArray () override

const Int_t *	GetRowIndexArray () const override

Int_t *	GetRowIndexArray () override

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

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 override
	Get submatrix [row_lwb..row_upb][col_lwb..col_upb]; The indexing range of the returned matrix depends on the argument option:

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

TClass *	IsA () const override

Bool_t	IsSymmetric () const override
	Check whether matrix is symmetric.

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

Int_t	NonZeros () const override
	Compute the number of elements != 0.0.

TMatrixTBase< Element > &	NormByDiag (const TVectorT< Element > &, Option_t *) override
	option:

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

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

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.

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.

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.

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

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

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

TMatrixTSparseRow< Element >	operator[] (Int_t rown)

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

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

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

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

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

TMatrixTBase< Element > &	ResizeTo (Int_t row_lwb, Int_t row_upb, Int_t col_lwb, Int_t col_upb, Int_t nr_nonzeros=-1) override
	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 .

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

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

TMatrixTBase< Element > &	SetMatrixArray (const Element data, Option_t ="") override
	Copy array data to matrix .

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 .

virtual TMatrixTBase< Element > &	SetMatrixArray (Int_t nr_nonzeros, Int_t nrows, Int_t ncols, Int_t irow, Int_t icol, Element *data)

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

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

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

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.

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.

TMatrixTBase< Element > &	SetSub (Int_t row_lwb, Int_t col_lwb, const TMatrixTBase< Element > &source) override
	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];.

void	Streamer (TBuffer &) override
	Stream an object of class TMatrixTSparse.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

TMatrixTSparse< Element > &	T ()

TMatrixTSparse< Element > &	Transpose (const TMatrixTSparse< Element > &source)
	Transpose a matrix. Set the matrix to ncols x nrows if nrows != ncols.

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

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)

TMatrixTBase< Element > &	Zero () override
	Set matrix elements to zero.

Public Member Functions inherited from TMatrixTBase< Element >
	TMatrixTBase ()

	~TMatrixTBase () override

virtual TMatrixTBase< Element > &	Abs ()
	Take an absolute value of a matrix, i.e. apply Abs() to each element.

virtual TMatrixTBase< Element > &	Apply (const TElementActionT< Element > &action)
	Apply action to each matrix element.

virtual TMatrixTBase< Element > &	Apply (const TElementPosActionT< Element > &action)
	Apply action to each element of the matrix.

TClass *	Class ()

virtual Double_t	Determinant () const

virtual void	Determinant (Double_t &d1, Double_t &d2) const

void	Draw (Option_t *option="") override
	Draw this matrix The histogram is named "TMatrixT" by default and no title.

virtual Element	E2Norm () const
	Square of the Euclidean norm, SUM{ m(i,j)^2 }.

Int_t	GetColLwb () const

Int_t	GetColUpb () const

Int_t	GetNcols () const

Int_t	GetNoElements () const

Int_t	GetNrows () const

Int_t	GetRowLwb () const

Int_t	GetRowUpb () const

Element	GetTol () const

void	Invalidate ()

Bool_t	IsOwner () const

Bool_t	IsValid () const

void	MakeValid ()

virtual Element	Max () const
	return maximum vector element value

virtual Element	Min () const
	return minimum matrix element value

Element	Norm1 () const

Element	NormInf () const

Bool_t	operator!= (Element val) const
	Are all matrix elements not equal to val?

Bool_t	operator< (Element val) const
	Are all matrix elements < val?

Bool_t	operator<= (Element val) const
	Are all matrix elements <= val?

Bool_t	operator== (Element val) const
	Are all matrix elements equal to val?

Bool_t	operator> (Element val) const
	Are all matrix elements > val?

Bool_t	operator>= (Element val) const
	Are all matrix elements >= val?

void	Print (Option_t *name="") const override
	Print the matrix as a table of elements.

Element	SetTol (Element tol)

virtual TMatrixTBase< Element > &	Shift (Int_t row_shift, Int_t col_shift)
	Shift the row index by adding row_shift and the column index by adding col_shift, respectively.

virtual TMatrixTBase< Element > &	Sqr ()
	Square each element of the matrix.

virtual TMatrixTBase< Element > &	Sqrt ()
	Take square root of all elements.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual Element	Sum () const
	Compute sum of elements.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TMatrixTBase< Element >
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Element &	NaNValue ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

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.

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

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

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

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.

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

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

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.

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

void	conservative_sparse_sparse_product_impl (const TMatrixTSparse< Element > &lhs, const TMatrixTSparse< Element > &rhs, Int_t constr=0)
	General Sparse Matrix Multiplication (SpMM).

Int_t	ReduceSparseMatrix (Int_t nr, Int_t row, Int_t col, Element *data)
	Sum matrix entries corresponding to the same matrix element (i,j).

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes
Int_t *	fColIndex

Element *	fElements

Int_t *	fRowIndex

Protected Attributes inherited from TMatrixTBase< Element >
Int_t	fColLwb

Bool_t	fIsOwner

Int_t	fNcols

Int_t	fNelems

Int_t	fNrowIndex

Int_t	fNrows

Int_t	fRowLwb

Element	fTol

Additional Inherited Members
Protected Types inherited from TMatrixTBase< Element >
enum	{ kSizeMax = 25 }

enum	{ kWorkMax = 100 }

enum	EMatrixStatusBits { kStatus = (1ULL << ( 14 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Static Protected Member Functions inherited from TMatrixTBase< Element >
static void	DoubleLexSort (Int_t n, Int_t first, Int_t second, Element *data)
	default kTRUE, when Use array kFALSE

static void	IndexedLexSort (Int_t n, Int_t first, Int_t swapFirst, Int_t second, Int_t swapSecond, Int_t *index)
	Lexical sort on array data using indices first and second.

#include <TMatrixTSparse.h>

Inheritance diagram for TMatrixTSparse< Element >:

[legend]

Member Enumeration Documentation

◆ EMatrixCreatorsOp1

template<class Element >

enum TMatrixTSparse::EMatrixCreatorsOp1

Enumerator
kZero
kUnit
kTransposed
kAtA

Definition at line 80 of file TMatrixTSparse.h.

◆ EMatrixCreatorsOp2

template<class Element >

enum TMatrixTSparse::EMatrixCreatorsOp2

Enumerator
kMult
kMultTranspose
kPlus
kMinus

Definition at line 81 of file TMatrixTSparse.h.

Constructor & Destructor Documentation

◆ TMatrixTSparse() [1/11]

template<class Element >

TMatrixTSparse< Element >::TMatrixTSparse ( )

inline

Definition at line 83 of file TMatrixTSparse.h.

◆ TMatrixTSparse() [2/11]

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 107 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [3/11]

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_nonzeros = `0`
	)

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

Definition at line 117 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [4/11]

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. Here row, col and data are arrays of length nr (number of nonzero elements), i.e. the matrix is stored in COO (coordinate) format. Note that the input arrays are not passed as const since they will be modified !

Definition at line 130 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [5/11]

template<class Element >

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

Space is allocated for row/column indices and data.

Sparsity pattern is given by column indices and row pointers from arrays col and rowptr, resp, while matrix entries come from the array data. Arrays col and data are assumed to have length nr (number of nonzero elements), while array rowptr has length (n+1), where n=row_upb-row_lwb+1 is the number of rows.

Definition at line 174 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [6/11]

template<class Element >

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

Definition at line 211 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [7/11]

template<class Element >

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

Definition at line 224 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [8/11]

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 237 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [9/11]

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 287 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [10/11]

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 319 of file TMatrixTSparse.cxx.

◆ TMatrixTSparse() [11/11]

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 351 of file TMatrixTSparse.cxx.

◆ ~TMatrixTSparse()

template<class Element >

TMatrixTSparse< Element >::~TMatrixTSparse ( )

inlineoverride

Definition at line 97 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 384 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.

Replace this matrix with C such that C = A - B. Note, matrix C is allocated for constr=1.

Definition at line 1151 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.

Replace this matrix with C such that C = A - B. Note, matrix C is allocated for constr=1.

Definition at line 1080 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.

Replace this matrix with C such that C = A - B. Note, matrix C is allocated for constr=1.

Definition at line 998 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 54 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 51 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.

Replace this matrix with C such that C = A * B'. Note, matrix C is allocated for constr=1.

Definition at line 753 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.

Replace this matrix with C such that C = A * B'. Note, matrix C is allocated for constr=1.

Definition at line 662 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`
	)

inlineprotected

Definition at line 57 of file TMatrixTSparse.h.

◆ 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 67 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.

Replace this matrix with C such that C = A + B. Note, matrix C is allocated for constr=1.

Definition at line 927 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.

Replace this matrix with C such that C = A + B. Note, matrix C is allocated for constr=1.

Definition at line 845 of file TMatrixTSparse.cxx.

◆ Class() [1/2]

template<class Element >

static TClass * TMatrixTSparse< Element >::Class ( )

static

Returns: TClass describing this class

◆ Class() [2/2]

TClass * TMatrixTSparse< double >::Class ( )

◆ Class_Name()

template<class Element >

static const char * TMatrixTSparse< Element >::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

template<class Element >

static constexpr Version_t TMatrixTSparse< Element >::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 215 of file TMatrixTSparse.h.

◆ Clear()

template<class Element >

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

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 130 of file TMatrixTSparse.h.

◆ ColNorm()

template<class Element >

Element TMatrixTSparse< Element >::ColNorm

overridevirtual

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

The norm is induced by the 1 vector norm.

Reimplemented from TMatrixTBase< Element >.

Definition at line 2341 of file TMatrixTSparse.cxx.

◆ conservative_sparse_sparse_product_impl()

template<class Element >

void TMatrixTSparse< Element >::conservative_sparse_sparse_product_impl	(	const TMatrixTSparse< Element > &	lhs,
		const TMatrixTSparse< Element > &	rhs,
		Int_t	constr = `0`
	)

protected

General Sparse Matrix Multiplication (SpMM).

This code is an adaptation of Eigen SpMM implementation. This product is conservative, meaning that it preserves the symbolic non zeros. Given lhs, rhs, it computes this = rhs * lhs. Note, result matrix is only allocated when constr=1.

Definition at line 552 of file TMatrixTSparse.cxx.

◆ DeclFileName()

template<class Element >

static const char * TMatrixTSparse< Element >::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 215 of file TMatrixTSparse.h.

◆ ExtractRow()

template<class Element >

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

overridevirtual

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

Reimplemented from TMatrixTBase< Element >.

Definition at line 509 of file TMatrixTSparse.cxx.

◆ GetColIndexArray() [1/2]

template<class Element >

const Int_t * TMatrixTSparse< Element >::GetColIndexArray

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 231 of file TMatrixTSparse.h.

◆ GetColIndexArray() [2/2]

template<class Element >

Int_t * TMatrixTSparse< Element >::GetColIndexArray

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 232 of file TMatrixTSparse.h.

◆ GetMatrix2Array()

template<class Element >

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

overridevirtual

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

Reimplemented from TMatrixTBase< Element >.

Definition at line 1221 of file TMatrixTSparse.cxx.

◆ GetMatrixArray() [1/2]

template<class Element >

const Element * TMatrixTSparse< Element >::GetMatrixArray

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 227 of file TMatrixTSparse.h.

◆ GetMatrixArray() [2/2]

template<class Element >

Element * TMatrixTSparse< Element >::GetMatrixArray

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 228 of file TMatrixTSparse.h.

◆ GetRowIndexArray() [1/2]

template<class Element >

const Int_t * TMatrixTSparse< Element >::GetRowIndexArray

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 229 of file TMatrixTSparse.h.

◆ GetRowIndexArray() [2/2]

template<class Element >

Int_t * TMatrixTSparse< Element >::GetRowIndexArray

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 230 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 256 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

overridevirtual

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]

Implements TMatrixTBase< Element >.

Definition at line 1966 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`
	)

overridevirtual

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

Reimplemented from TMatrixTBase< Element >.

Definition at line 426 of file TMatrixTSparse.cxx.

◆ IsA()

template<class Element >

TClass * TMatrixTSparse< Element >::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TMatrixTBase< Element >.

Definition at line 215 of file TMatrixTSparse.h.

◆ IsSymmetric()

template<class Element >

Bool_t TMatrixTSparse< Element >::IsSymmetric ( ) const

inlineoverridevirtual

Check whether matrix is symmetric.

Reimplemented from TMatrixTBase< Element >.

Definition at line 160 of file TMatrixTSparse.h.

◆ Mult()

template<class Element >

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

inline

Definition at line 164 of file TMatrixTSparse.h.

◆ NonZeros()

template<class Element >

Int_t TMatrixTSparse< Element >::NonZeros ( ) const

inlineoverridevirtual

Compute the number of elements != 0.0.

Reimplemented from TMatrixTBase< Element >.

Definition at line 171 of file TMatrixTSparse.h.

◆ NormByDiag()

template<class Element >

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

inlineoverridevirtual

option:

"D" : b(i,j) = a(i,j)/sqrt(abs*(v(i)*v(j))) (default)
else : b(i,j) = a(i,j)*sqrt(abs*(v(i)*v(j))) (default)

Reimplemented from TMatrixTBase< Element >.

Definition at line 173 of file TMatrixTSparse.h.

◆ operator()() [1/2]

template<class Element >

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

overridevirtual

Implements TMatrixTBase< Element >.

Definition at line 2413 of file TMatrixTSparse.cxx.

◆ operator()() [2/2]

template<class Element >

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

overridevirtual

Implements TMatrixTBase< Element >.

Definition at line 2369 of file TMatrixTSparse.cxx.

◆ operator*=() [1/3]

template<class Element >

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

inline

Definition at line 208 of file TMatrixTSparse.h.

◆ operator*=() [2/3]

template<class Element >

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

inline

Definition at line 204 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 2552 of file TMatrixTSparse.cxx.

◆ operator+=() [1/3]

template<class Element >

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

inline

Definition at line 196 of file TMatrixTSparse.h.

◆ operator+=() [2/3]

template<class Element >

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

inline

Definition at line 192 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 2520 of file TMatrixTSparse.cxx.

◆ operator-=() [1/3]

template<class Element >

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

inline

Definition at line 202 of file TMatrixTSparse.h.

◆ operator-=() [2/3]

template<class Element >

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

inline

Definition at line 198 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 2536 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 2468 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 2445 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 2499 of file TMatrixTSparse.cxx.

◆ operator[]() [1/2]

template<class Element >

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

inline

Definition at line 182 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 181 of file TMatrixTSparse.h.

◆ Randomize()

template<class Element >

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

overridevirtual

randomize matrix element values

Reimplemented from TMatrixTBase< Element >.

Definition at line 2568 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 2615 of file TMatrixTSparse.cxx.

◆ ReduceSparseMatrix()

template<class Element >

Int_t TMatrixTSparse< Element >::ReduceSparseMatrix	(	Int_t	nr,
		Int_t *	row,
		Int_t *	col,
		Element *	data
	)

protected

Sum matrix entries corresponding to the same matrix element (i,j).

The reduced extries remain dangling. It is assumed that the arrays row, col and data are sorted with DoubleLexSort. Note that the input arrays are not passed as const since they will be modified !

Definition at line 1328 of file TMatrixTSparse.cxx.

◆ ResizeTo() [1/3]

template<class Element >

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

inline

Definition at line 127 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`
	)

overridevirtual

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.

Implements TMatrixTBase< Element >.

Definition at line 1733 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`
	)

overridevirtual

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.

Implements TMatrixTBase< Element >.

Definition at line 1827 of file TMatrixTSparse.cxx.

◆ RowNorm()

template<class Element >

Element TMatrixTSparse< Element >::RowNorm

overridevirtual

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

The norm is induced by the infinity vector norm.

Reimplemented from TMatrixTBase< Element >.

Definition at line 2312 of file TMatrixTSparse.cxx.

◆ SetColIndexArray()

template<class Element >

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

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 107 of file TMatrixTSparse.h.

◆ SetMatrixArray() [1/3]

template<class Element >

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

inlineoverridevirtual

Copy array data to matrix .

It is assumed that array is of size >= fNelems (=)))) fNrows*fNcols option indicates how the data is stored in the array: option =

'F' : column major (Fortran) m[i][j] = array[i+j*fNrows]
else : row major (C) m[i][j] = array[i*fNcols+j] (default)

Reimplemented from TMatrixTBase< Element >.

Definition at line 117 of file TMatrixTSparse.h.

◆ SetMatrixArray() [2/3]

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 1235 of file TMatrixTSparse.cxx.

◆ SetMatrixArray() [3/3]

template<class Element >

TMatrixTBase< Element > & TMatrixTSparse< Element >::SetMatrixArray	(	Int_t	nr_nonzeros,
		Int_t	nrows,
		Int_t	ncols,
		Int_t *	irow,
		Int_t *	icol,
		Element *	data
	)

virtual

Definition at line 1354 of file TMatrixTSparse.cxx.

◆ SetRowIndexArray()

template<class Element >

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

inlineoverridevirtual

Implements TMatrixTBase< Element >.

Definition at line 106 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 1511 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 1477 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 1648 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 113 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 1554 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
	)

overridevirtual

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];.

Implements TMatrixTBase< Element >.

Definition at line 2066 of file TMatrixTSparse.cxx.

◆ Streamer()

template<class Element >

void TMatrixTSparse< Element >::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TMatrixTSparse.

Reimplemented from TMatrixTBase< Element >.

Definition at line 2989 of file TMatrixTSparse.cxx.

◆ StreamerNVirtual()

template<class Element >

void TMatrixTSparse< Element >::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 215 of file TMatrixTSparse.h.

◆ T()

template<class Element >

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

inline

Definition at line 162 of file TMatrixTSparse.h.

◆ Transpose()

template<class Element >

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

Transpose a matrix. Set the matrix to ncols x nrows if nrows != ncols.

Definition at line 2202 of file TMatrixTSparse.cxx.

◆ UnitMatrix()

template<class Element >

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

overridevirtual

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

Reimplemented from TMatrixTBase< Element >.

Definition at line 2270 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 249 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 239 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 235 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 141 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 1926 of file TMatrixTSparse.cxx.

◆ Use() [6/6]

template<class Element >

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

inline

Definition at line 243 of file TMatrixTSparse.h.

◆ Zero()

template<class Element >

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

overridevirtual

Set matrix elements to zero.

Reimplemented from TMatrixTBase< Element >.

Definition at line 2254 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.

math/matrix/inc/TMatrixDSparsefwd.h

math/matrix/inc/TMatrixTSparse.h

math/matrix/src/TMatrixTSparse.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EMatrixCreatorsOp1

◆ EMatrixCreatorsOp2

Constructor & Destructor Documentation

◆ TMatrixTSparse() [1/11]

◆ TMatrixTSparse() [2/11]

◆ TMatrixTSparse() [3/11]

◆ TMatrixTSparse() [4/11]

◆ TMatrixTSparse() [5/11]

◆ TMatrixTSparse() [6/11]

◆ TMatrixTSparse() [7/11]

◆ TMatrixTSparse() [8/11]

◆ TMatrixTSparse() [9/11]

◆ TMatrixTSparse() [10/11]

◆ TMatrixTSparse() [11/11]

◆ ~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() [1/2]

◆ Class() [2/2]

◆ Class_Name()

◆ Class_Version()

◆ Clear()

◆ ColNorm()

◆ conservative_sparse_sparse_product_impl()

◆ DeclFileName()

◆ 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()

◆ IsA()

◆ 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()

◆ ReduceSparseMatrix()

◆ ResizeTo() [1/3]