SparseMatrix< T > Class Template Reference

Class for storing sparse matrices More...

Inheritance diagram for SparseMatrix< T >:

Public Member Functions
virtual IMatrix< T >	CreateMatrix (int num_rows, int num_columns)
	Create a matrix with a given number of rows and columns
void	Resize (int num_rows, int num_cols)
	Grows or shrinks the matrix to the requested size, if necessary
	SparseMatrix (int num_rows, int num_cols)
	Create a sparse matrix with a given number of rows
virtual IMatrix< T >	Transpose ()
	Get the transpose of the matrix, i.e. a matrix where rows and columns are interchanged

Properties
virtual bool	IsSymmetric [get]
virtual IList< Tuple< int, int > >	NonEmptyEntryIDs [get]
	The row and column IDs of non-empty entries in the matrix
int	NumberOfColumns [get, set]
virtual int	NumberOfNonEmptyEntries [get]
	The number of non-empty entries in the matrix
int	NumberOfRows [get]
virtual T	this[int x, int y] [get, set]
	Access the elements of the sparse matrix
Dictionary< int, T >	this[int x] [get]
	Get a row of the matrix

Detailed Description

Class for storing sparse matrices

The data is stored in row-major mode. Indexes are zero-based. Access is internally done by binary search.

Template Parameters

T	the matrix element type, must have a default constructor/value

Type Constraints

T

:

new()

Member Function Documentation

virtual IMatrix<T> CreateMatrix ( int  num_rows, int  num_columns  )

inlinevirtual

Create a matrix with a given number of rows and columns

Parameters

num_rows	the number of rows
num_columns	the number of columns

Returns

A matrix with num_rows rows and num_column columns

Implements IMatrix< T >.

Reimplemented in SkewSymmetricSparseMatrix, SymmetricSparseMatrix< T >, SymmetricSparseMatrix-g< float >, and SymmetricSparseMatrix-g< int >.

void Resize ( int  num_rows, int  num_cols  )

inline

Grows or shrinks the matrix to the requested size, if necessary

The new entries are filled with zeros. Obsolete entries are removed.

Parameters

num_rows	the number of rows
num_cols	the number of columns

Implements IMatrix< T >.

SparseMatrix ( int  num_rows, int  num_cols  )

inline

Create a sparse matrix with a given number of rows

Parameters

num_rows	the number of rows
num_cols	the number of columns

virtual IMatrix<T> Transpose ( )

inlinevirtual

Get the transpose of the matrix, i.e. a matrix where rows and columns are interchanged

Returns

the transpose of the matrix (copy)

Implements IMatrix< T >.

Property Documentation

virtual IList<Tuple<int, int> > NonEmptyEntryIDs

get

The row and column IDs of non-empty entries in the matrix

The row and column IDs of non-empty entries in the matrix

virtual int NumberOfNonEmptyEntries

get

The number of non-empty entries in the matrix

The number of non-empty entries in the matrix

virtual T this[int x, int y]

getset

Access the elements of the sparse matrix

Parameters

x	the row ID
y	the column ID

Dictionary<int, T> this[int x]

get

Get a row of the matrix

Parameters

x	the row ID

---

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

• SparseMatrix.cs