SymmetricSparseMatrix< T > Class Template Reference

a symmetric sparse matrix; consumes less memory More...

Inheritance diagram for SymmetricSparseMatrix< T >:
SparseMatrix< T > IMatrix< T >

List of all members.

Public Member Functions

override IMatrix< T > CreateMatrix (int num_rows, int num_columns)
 Create a matrix with a given number of rows and columns.
void Grow (int num_rows, int num_cols)
 Grows the matrix to the requested size, if necessary.
 SymmetricSparseMatrix (int dimension)
 Create a symmetric sparse matrix with a given dimension.
virtual IMatrix< T > Transpose ()
 Get the transpose of the matrix, i.e. a matrix where rows and columns are interchanged.

Protected Attributes

internal List< Dictionary< int,
T > > 
row_list = new List<Dictionary<int, T>>()
 List that stores the rows of the matrix.

Properties

override bool IsSymmetric [get]
 Always true because the data type is symmetric.
override IList< Pair< int, int > > NonEmptyEntryIDs [get]
 The row and column IDs of non-empty entries in the matrix.
IList< KeyValuePair< int,
Dictionary< int, T > > > 
NonEmptyRows [get]
 The non-empty rows of the matrix (the ones that contain at least one non-zero entry), with their IDs.
int NumberOfColumns [get, set]
 The number of columns of the matrix.
override int NumberOfNonEmptyEntries [get]
 The number of non-empty entries in the matrix.
int NumberOfRows [get]
 The number of rows of the matrix.
override T this [int x, int y] [get, set]
 Access the elements of the sparse matrix.

Detailed Description

template<T>
class MyMediaLite::DataType::SymmetricSparseMatrix< T >

a symmetric sparse matrix; consumes less memory

Be careful when accessing the matrix via the NonEmptyRows property: this contains only the entries with x >, but not their symmetric counterparts.

Type Constraints
T :new() 

Constructor & Destructor Documentation

SymmetricSparseMatrix ( int  dimension  )  [inline]

Create a symmetric sparse matrix with a given dimension.

Parameters:
dimension the dimension (number of rows/columns)

Member Function Documentation

override IMatrix<T> CreateMatrix ( int  num_rows,
int  num_columns 
) [inline, virtual]

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

Reimplemented from SparseMatrix< T >.

void Grow ( int  num_rows,
int  num_cols 
) [inline, inherited]

Grows the matrix to the requested size, if necessary.

The new entries are filled with zeros.

Parameters:
num_rows the minimum number of rows
num_cols the minimum number of columns

Implements IMatrix< T >.

virtual IMatrix<T> Transpose (  )  [inline, virtual, inherited]

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


Member Data Documentation

internal List<Dictionary<int, T> > row_list = new List<Dictionary<int, T>>() [protected, inherited]

List that stores the rows of the matrix.


Property Documentation

override bool IsSymmetric [get]

Always true because the data type is symmetric.

Always true because the data type is symmetric

Reimplemented from SparseMatrix< T >.

override IList<Pair<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

Reimplemented from SparseMatrix< T >.

IList<KeyValuePair<int, Dictionary<int, T> > > NonEmptyRows [get, inherited]

The non-empty rows of the matrix (the ones that contain at least one non-zero entry), with their IDs.

int NumberOfColumns [get, set, inherited]

The number of columns of the matrix.

The number of columns of the matrix

Implements IMatrix< T >.

override int NumberOfNonEmptyEntries [get]

The number of non-empty entries in the matrix.

The number of non-empty entries in the matrix

Reimplemented from SparseMatrix< T >.

int NumberOfRows [get, inherited]

The number of rows of the matrix.

The number of rows of the matrix

Implements IMatrix< T >.

override T this[int x, int y] [get, set]

Access the elements of the sparse matrix.

Parameters:
x the row ID
y the column ID

Reimplemented from SparseMatrix< T >.


The documentation for this class was generated from the following file:
Generated on Fri Mar 2 21:19:32 2012 for MyMediaLite by  doxygen 1.6.3