MyMediaLite  3.10
Public Member Functions | Protected Member Functions | Properties | List of all members
BinaryCosine Class Reference

Class for storing cosine similarities More...

Inheritance diagram for BinaryCosine:
BinaryDataSymmetricCorrelationMatrix SymmetricCorrelationMatrix IBinaryDataCorrelationMatrix SymmetricSparseMatrix< T > ICorrelationMatrix ICorrelationMatrix SparseMatrix< T > IMatrix< T > IMatrix< T > IMatrix< T >

Public Member Functions

void AddEntity (int entity_id)
 Add an entity to the ICorrelationMatrix by growing it to the requested size.
 BinaryCosine (int num_entities)
 Creates an object of type Cosine
float ComputeCorrelation (ICollection< int > vector_i, ICollection< int > vector_j)
 Computes the correlation of two binary vectors
void ComputeCorrelations (IBooleanMatrix entity_data)
 Compute the correlations from an implicit feedback, positive-only dataset
override IMatrix< T > CreateMatrix (int num_rows, int num_columns)
 Create a matrix with a given number of rows and columns
override void Resize (int size)
 Resize to the given size
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
 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
void Write (StreamWriter writer)
 Write out the correlations to a StreamWriter

Protected Member Functions

override float ComputeCorrelationFromOverlap (float overlap, float count_x, float count_y)

Properties

override bool IsSymmetric [get]
 returns true if the matrix is symmetric, which is generally the case for similarity matrices
override IList< Tuple< int, int > > NonEmptyEntryIDs [get]
int NumberOfColumns [get, set]
override int NumberOfNonEmptyEntries [get]
int NumberOfRows [get]
int NumEntities [get, set]
 Number of entities the correlation is defined over
override 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
bool Weighted [get, set]

Detailed Description

Class for storing cosine similarities

http://en.wikipedia.org/wiki/Cosine_similarity

Constructor & Destructor Documentation

BinaryCosine ( int  num_entities)
inline

Creates an object of type Cosine

Parameters
num_entitiesthe number of entities

Member Function Documentation

void AddEntity ( int  entity_id)
inlineinherited

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

Implements ICorrelationMatrix.

float ComputeCorrelation ( ICollection< int >  vector_i,
ICollection< int >  vector_j 
)
inlineinherited

Computes the correlation of two binary vectors

Parameters
vector_ithe first vector
vector_jthe second vector
Returns
the correlation of the two vectors

Implements IBinaryDataCorrelationMatrix.

void ComputeCorrelations ( IBooleanMatrix  entity_data)
inlineinherited

Compute the correlations from an implicit feedback, positive-only dataset

Parameters
entity_datathe implicit feedback set, rows contain the entities to correlate

Implements IBinaryDataCorrelationMatrix.

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

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

Reimplemented from SparseMatrix< T >.

Reimplemented in SkewSymmetricSparseMatrix.

override void Resize ( int  size)
inlineinherited

Resize to the given size

Parameters
sizethe size

Implements ICorrelationMatrix.

void Resize ( int  num_rows,
int  num_cols 
)
inlineinherited

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

Implements IMatrix< T >.

SparseMatrix ( int  num_rows,
int  num_cols 
)
inlineinherited

Create a sparse matrix with a given number of rows

Parameters
num_rowsthe number of rows
num_colsthe number of columns
SymmetricSparseMatrix ( int  dimension)
inlineinherited

Create a symmetric sparse matrix with a given dimension

Parameters
dimensionthe dimension (number of rows/columns)
virtual IMatrix<T> Transpose ( )
inlinevirtualinherited

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

void Write ( StreamWriter  writer)
inlineinherited

Write out the correlations to a StreamWriter

Parameters
writerA StreamWriter

Implements ICorrelationMatrix.

Property Documentation

int NumEntities
getsetinherited

Number of entities the correlation is defined over

override T this[int x, int y]
getsetinherited

Access the elements of the sparse matrix

Parameters
xthe row ID
ythe column ID
Dictionary<int, T> this[int x]
getinherited

Get a row of the matrix

Parameters
xthe row ID

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