IRatingCorrelationMatrix Interface Reference

CorrelationMatrix that computes correlations over rating data More...

Inheritance diagram for IRatingCorrelationMatrix:

Public Member Functions
void	AddEntity (int entity_id)
	Add an entity to the ICorrelationMatrix by growing it to the requested size. More...
float	ComputeCorrelation (IRatings ratings, EntityType entity_type, int i, int j)
	Computes the correlation of two rating vectors More...
float	ComputeCorrelation (IRatings ratings, EntityType entity_type, IList< Tuple< int, float >> entity_ratings, int j)
	Compute correlation between two entities for given ratings More...
void	ComputeCorrelations (IRatings ratings, EntityType entity_type)
	Compute the correlations for a given entity type from a rating dataset 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...
T	this[int x, int y] [get, set]
	The value at (i,j) More...

Detailed Description

CorrelationMatrix that computes correlations over rating data

Member Function Documentation

void AddEntity ( int  entity_id )

inherited

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_id

the numerical ID of the entity

Implemented in SymmetricCorrelationMatrix, and AsymmetricCorrelationMatrix.

float ComputeCorrelation	(	IRatings	ratings,
		EntityType	entity_type,
		int	i,
		int	j
	)

Computes the correlation of two rating vectors

Parameters

ratings	the rating data
entity_type	the entity type, either USER or ITEM
i	the ID of the first entity
j	the ID of the second entity

Returns

the correlation of the two vectors

Implemented in Pearson.

float ComputeCorrelation	(	IRatings	ratings,
		EntityType	entity_type,
		IList< Tuple< int, float >>	entity_ratings,
		int	j
	)

Compute correlation between two entities for given ratings

Parameters

ratings	the rating data
entity_type	the entity type, either USER or ITEM
entity_ratings	ratings identifying the first entity
j	the ID of second entity

Implemented in Pearson.

void ComputeCorrelations	(	IRatings	ratings,
		EntityType	entity_type
	)

Compute the correlations for a given entity type from a rating dataset

Parameters

ratings	the rating data
entity_type	the EntityType - either USER or ITEM

Implemented in Pearson.

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

inherited

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

void Resize ( int  size )

inherited

Resize to the given size

Parameters

size

the 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_rows	the number of rows
num_cols	the 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 )

inherited

Write out the correlations to a StreamWriter

Parameters

writer

A 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

getinherited

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

x	the row ID
y	the column ID

---

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

• IRatingCorrelationMatrix.cs