MyMediaLite  3.09
Public Member Functions | Properties
IMatrix< T > Interface Template Reference

Generic interface for matrix data types. More...

Inheritance diagram for IMatrix< T >:
ICorrelationMatrix IBooleanMatrix Matrix< T > SparseMatrix< T > SymmetricMatrix< T > AsymmetricCorrelationMatrix IBinaryDataCorrelationMatrix IRatingCorrelationMatrix SymmetricCorrelationMatrix SparseBooleanMatrix AsymmetricCorrelationMatrix SymmetricSparseMatrix< T > BinaryDataAsymmetricCorrelationMatrix BinaryDataAsymmetricCorrelationMatrix BinaryDataSymmetricCorrelationMatrix Pearson BinaryDataSymmetricCorrelationMatrix Pearson BinaryDataAsymmetricCorrelationMatrix SymmetricCorrelationMatrix SkewSymmetricSparseMatrix

List of all members.

Public Member Functions

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.
IMatrix< T > Transpose ()
 Get the transpose of the matrix, i.e. a matrix where rows and columns are interchanged.

Properties

bool IsSymmetric [get]
 True if the matrix is stored in a symmetric manner, false otherwise.
int NumberOfColumns [get]
 The number of columns of the matrix.
int NumberOfRows [get]
 The number of rows of the matrix.
this[int x, int y] [get, set]
 The value at (i,j)

Detailed Description

template<T>
interface MyMediaLite::DataType::IMatrix< T >

Generic interface for matrix data types.


Member Function Documentation

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

Create a matrix with a given number of rows and columns.

Parameters:
num_rowsthe number of rows
num_columnsthe number of columns
Returns:
A matrix with num_rows rows and num_column columns

Implemented in SparseMatrix< T >, Matrix< T >, SparseBooleanMatrix, SkewSymmetricSparseMatrix, SymmetricMatrix< T >, and SymmetricSparseMatrix< T >.

void Resize ( int  num_rows,
int  num_cols 
)

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

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

Parameters:
num_rowsthe number of rows
num_colsthe number of columns

Implemented in Matrix< T >, SparseBooleanMatrix, SparseMatrix< T >, and SymmetricMatrix< T >.

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

Returns:
the transpose of the matrix (copy)

Implemented in SparseBooleanMatrix, SparseMatrix< T >, Matrix< T >, and SymmetricMatrix< T >.


Property Documentation

bool IsSymmetric [get]

True if the matrix is stored in a symmetric manner, false otherwise.

Also true for skew symmetric matrices that exploit this property in order to save memory

Implemented in SparseBooleanMatrix, SkewSymmetricSparseMatrix, SymmetricSparseMatrix< T >, Matrix< T >, AsymmetricCorrelationMatrix, SymmetricCorrelationMatrix, SparseMatrix< T >, and SymmetricMatrix< T >.

int NumberOfColumns [get]

The number of columns of the matrix.

The number of columns of the matrix

Implemented in SparseBooleanMatrix, Matrix< T >, SparseMatrix< T >, and SymmetricMatrix< T >.

int NumberOfRows [get]

The number of rows of the matrix.

The number of rows of the matrix

Implemented in SparseBooleanMatrix, Matrix< T >, SparseMatrix< T >, and SymmetricMatrix< T >.

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

The value at (i,j)

The value at (i,j)

Parameters:
xthe row ID
ythe column ID

Implemented in SparseMatrix< T >, SparseBooleanMatrix, SkewSymmetricSparseMatrix, and SymmetricSparseMatrix< T >.


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