MyMediaLite  3.11
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
BinaryDataAsymmetricCorrelationMatrix Class Referenceabstract

Class with commoin routines for asymmetric correlations that are learned from binary data More...

Inheritance diagram for BinaryDataAsymmetricCorrelationMatrix:
AsymmetricCorrelationMatrix IBinaryDataCorrelationMatrix SparseMatrix< float > ICorrelationMatrix ICorrelationMatrix IMatrix< float > IMatrix< float > BidirectionalConditionalProbability ConditionalProbability

Public Member Functions

void AddEntity (int entity_id)
 Add an entity to the ICorrelationMatrix by growing it to the requested size. More...
 
 BinaryDataAsymmetricCorrelationMatrix (int num_entities)
 Creates an object of type ConditionalProbability More...
 
float ComputeCorrelation (ICollection< int > vector_i, ICollection< int > vector_j)
 Computes the correlation of two binary vectors More...
 
void ComputeCorrelations (IBooleanMatrix entity_data)
 Compute the correlations from an implicit feedback, positive-only dataset More...
 
IMatrix< T > CreateMatrix (int num_rows, int num_columns)
 Create a matrix with a given number of rows and columns More...
 
IMatrix< T > CreateMatrix (int num_rows, int num_columns)
 Create a matrix with a given number of rows and columns More...
 
virtual IMatrix< T > CreateMatrix (int num_rows, int num_columns)
 Create a matrix with a given number of rows and columns More...
 
void Resize (int num_rows, int num_cols)
 Grows or shrinks the matrix to the requested size, if necessary More...
 
void Resize (int num_rows, int num_cols)
 Grows or shrinks the matrix to the requested size, if necessary More...
 
void Resize (int num_rows)
 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...
 
IMatrix< T > Transpose ()
 Get the transpose of the matrix, i.e. a matrix where rows and columns are interchanged More...
 
virtual 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...
 

Protected Member Functions

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

Protected Attributes

int num_entities
 Number of entities, e.g. users or items More...
 

Properties

override bool IsSymmetric [get]
 returns false
 
virtual IList< Tuple< int, int > > NonEmptyEntryIDs [get]
 The row and column IDs of non-empty entries in the matrix More...
 
int NumberOfColumns [get]
 The number of columns of the matrix More...
 
int NumberOfColumns [get]
 The number of columns of the matrix More...
 
int NumberOfColumns [get]
 
virtual int NumberOfNonEmptyEntries [get]
 The number of non-empty entries in the matrix More...
 
int NumberOfRows [get]
 The number of rows of the matrix More...
 
int NumberOfRows [get]
 The number of rows of the matrix More...
 
int NumberOfRows [get]
 
int NumEntities [get]
 
this[int x, int y] [get, set]
 The value at (i,j) More...
 
this[int x, int y] [get, set]
 The value at (i,j) More...
 
virtual T this[int x, int y] [get, set]
 Access the elements of the sparse matrix More...
 
Dictionary< int, T > this[int x] [get]
 Get a row of the matrix More...
 
bool Weighted [get, set]
 

Detailed Description

Class with commoin routines for asymmetric correlations that are learned from binary data

Constructor & Destructor Documentation

BinaryDataAsymmetricCorrelationMatrix ( int  num_entities)
inline

Creates an object of type ConditionalProbability

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 
)
inline

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)
inline

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

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

Implements IBinaryDataCorrelationMatrix.

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
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
virtual 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
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
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
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
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)
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)
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)
void Write ( StreamWriter  writer)
inlineinherited

Write out the correlations to a StreamWriter

Parameters
writerA StreamWriter

Implements ICorrelationMatrix.

Member Data Documentation

int num_entities
protectedinherited

Number of entities, e.g. users or items

Property Documentation

virtual IList<Tuple<int, int> > NonEmptyEntryIDs
getinherited

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

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

int NumberOfColumns
getinherited

The number of columns of the matrix

The number of columns of the matrix

int NumberOfColumns
getinherited

The number of columns of the matrix

The number of columns of the matrix

virtual int NumberOfNonEmptyEntries
getinherited

The number of non-empty entries in the matrix

The number of non-empty entries in the matrix

int NumberOfRows
getinherited

The number of rows of the matrix

The number of rows of the matrix

int NumberOfRows
getinherited

The number of rows of the matrix

The number of rows of the matrix

T this[int x, int y]
getsetinherited

The value at (i,j)

The value at (i,j)

Parameters
xthe row ID
ythe column ID
T this[int x, int y]
getsetinherited

The value at (i,j)

The value at (i,j)

Parameters
xthe row ID
ythe column ID
virtual 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: