MyMediaLite  3.11
Public Member Functions | Properties | List of all members
ICorrelationMatrix Interface Reference

Interface representing correlation and similarity matrices More...

Inheritance diagram for ICorrelationMatrix:
IMatrix< float > AsymmetricCorrelationMatrix IBinaryDataCorrelationMatrix IRatingCorrelationMatrix SymmetricCorrelationMatrix BinaryDataAsymmetricCorrelationMatrix BinaryDataAsymmetricCorrelationMatrix BinaryDataSymmetricCorrelationMatrix Pearson BinaryDataSymmetricCorrelationMatrix Pearson BidirectionalConditionalProbability ConditionalProbability BidirectionalConditionalProbability ConditionalProbability BinaryCosine Cooccurrence Jaccard RatingCosine BinaryCosine Cooccurrence Jaccard RatingCosine

Public Member Functions

void AddEntity (int entity_id)
 Add an entity to the ICorrelationMatrix by growing it to the requested size. More...
 
IMatrix< T > CreateMatrix (int num_rows, int num_columns)
 Create a matrix with a given number of rows and columns More...
 
void Resize (int size)
 Resize to the given size More...
 
void Resize (int num_rows, int num_cols)
 Grows or shrinks the matrix to the requested size, if necessary More...
 
IMatrix< T > Transpose ()
 Get the transpose of the matrix, i.e. a matrix where rows and columns are interchanged More...
 
void Write (StreamWriter writer)
 Write out the correlations to a StreamWriter More...
 

Properties

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

Detailed Description

Interface representing correlation and similarity matrices

Member Function Documentation

void AddEntity ( int  entity_id)

Add an entity to the ICorrelationMatrix by growing it to the requested size.

Note that you still have to correctly compute and set the entity's correlation values

Parameters
entity_idthe numerical ID of the entity

Implemented in SymmetricCorrelationMatrix, and AsymmetricCorrelationMatrix.

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

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
void Resize ( int  size)

Resize to the given size

Parameters
sizethe size

Implemented in AsymmetricCorrelationMatrix, and SymmetricCorrelationMatrix.

void Resize ( int  num_rows,
int  num_cols 
)
inherited

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
IMatrix<T> Transpose ( )
inherited

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

Returns
the transpose of the matrix (copy)
void Write ( StreamWriter  writer)

Write out the correlations to a StreamWriter

Parameters
writerA StreamWriter

Implemented in AsymmetricCorrelationMatrix, and SymmetricCorrelationMatrix.

Property Documentation

bool IsSymmetric
getinherited

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

int NumberOfColumns
getinherited

The number of columns of the matrix

The number of columns of the matrix

int NumberOfRows
getinherited

The number of rows of the matrix

The number of rows of the matrix

int NumEntities
get

size of the matrix (number of entities)

T this[int x, int y]
getsetinherited

The value at (i,j)

The value at (i,j)

Parameters
xthe row ID
ythe column ID

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