AsymmetricCorrelationMatrix Class Reference

Class for computing and storing correlations and similarities More...

Inheritance diagram for AsymmetricCorrelationMatrix:

Public Member Functions
void	AddEntity (int entity_id)
	Add an entity to the ICorrelationMatrix by growing it to the requested size. More...
	AsymmetricCorrelationMatrix (int num_entities)
	Creates a CorrelationMatrix object for a given number of entities 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)
	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...
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 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]
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]
int	NumEntities [get]
T	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...

Detailed Description

Class for computing and storing correlations and similarities

Constructor & Destructor Documentation

AsymmetricCorrelationMatrix ( int  num_entities )

inline

Creates a CorrelationMatrix object for a given number of entities

Parameters

num_entities

number of entities

Member Function Documentation

void AddEntity ( int  entity_id )

inline

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

Implements ICorrelationMatrix.

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

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

inlinevirtualinherited

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

void Resize ( int  size )

inline

Resize to the given size

Parameters

size

the 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_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)

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 )

inline

Write out the correlations to a StreamWriter

Parameters

writer

A StreamWriter

Implements ICorrelationMatrix.

Member Data Documentation

int num_entities

protected

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

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

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

virtual T this[int x, int y]

getsetinherited

Access the elements of the sparse matrix

Parameters

x	the row ID
y	the column ID

Dictionary<int, T> this[int x]

getinherited

Get a row of the matrix

Parameters

x	the row ID

---

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

• AsymmetricCorrelationMatrix.cs