AsymmetricCorrelationMatrix Class Reference

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

Inheritance diagram for AsymmetricCorrelationMatrix:

List of all members.

Public Member Functions
void	AddEntity (int entity_id)
	Add an entity to the ICorrelationMatrix by growing it to the requested size.
	AsymmetricCorrelationMatrix (int num_entities)
	Creates a CorrelationMatrix object for a given number of entities.
virtual IMatrix< T >	CreateMatrix (int num_rows, int num_columns)
	Create a matrix with a given number of rows and columns.
void	Resize (int num_rows)
	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.
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 Attributes
internal List< List< int > >	index_list = new List<List<int>>()
	List of lists that stores the column indices of the entries.
int	num_entities
	Number of entities, e.g. users or items.
internal List< List< T > >	value_list = new List<List<T>>()
	List of lists that stores the values of the entries.
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.
int	NumberOfColumns [get, set]
	The number of columns of the matrix.
virtual int	NumberOfNonEmptyEntries [get]
	The number of non-empty entries in the matrix.
int	NumberOfRows [get]
	The number of rows of the matrix.
int	NumEntities [get]
	size of the matrix (number of entities)
virtual 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.

---

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.

virtual IMatrix<T> CreateMatrix	(	int	num_rows,
		int	num_columns
	)		[inline, virtual, 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

Implements IMatrix< T >.

Reimplemented in SkewSymmetricSparseMatrix, and SymmetricSparseMatrix< T >.

void Resize

(

int

size

)

[inline]

Resize to the given size.

Parameters:

size

the size

Implements ICorrelationMatrix.

void Resize	(	int	num_rows,
		int	num_cols
	)		[inline, 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

Implements IMatrix< T >.

SparseMatrix	(	int	num_rows,
		int	num_cols
	)		[inline, inherited]

Create a sparse matrix with a given number of rows.

Parameters:

num_rows	the number of rows
num_cols	the number of columns

virtual IMatrix<T> Transpose

(

)

[inline, virtual, inherited]

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

)

[inline]

Write out the correlations to a StreamWriter.

Parameters:

writer

A StreamWriter

Implements ICorrelationMatrix.

---

Member Data Documentation

internal List<List<int> > index_list = new List<List<int>>() [protected, inherited]

List of lists that stores the column indices of the entries.

int num_entities [protected]

Number of entities, e.g. users or items.

internal List<List<T> > value_list = new List<List<T>>() [protected, inherited]

List of lists that stores the values of the entries.

---

Property Documentation

virtual IList<Tuple<int, int> > NonEmptyEntryIDs [get, inherited]

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

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

Reimplemented in SymmetricSparseMatrix< T >.

int NumberOfColumns [get, set, inherited]

The number of columns of the matrix.

The number of columns of the matrix

Implements IMatrix< T >.

virtual int NumberOfNonEmptyEntries [get, inherited]

The number of non-empty entries in the matrix.

The number of non-empty entries in the matrix

Reimplemented in SymmetricSparseMatrix< T >.

int NumberOfRows [get, inherited]

The number of rows of the matrix.

The number of rows of the matrix

Implements IMatrix< T >.

int NumEntities [get]

size of the matrix (number of entities)

Implements ICorrelationMatrix.

virtual T this[int x, int y] [get, set, inherited]

Access the elements of the sparse matrix.

Parameters:

x	the row ID
y	the column ID

Implements IMatrix< T >.

Reimplemented in SkewSymmetricSparseMatrix, and SymmetricSparseMatrix< T >.

Dictionary<int, T> this[int x] [get, inherited]

Get a row of the matrix.

Parameters:

x	the row ID

---

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

• AsymmetricCorrelationMatrix.cs