Class for storing and computing the co-counts More...

Inheritance diagram for Cooccurrence:

Public Member Functions
void	AddEntity (int entity_id)
	Add an entity to the ICorrelationMatrix by growing it to the requested size. 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...

	Cooccurrence (int num_entities)
	Creates an object of type Cooccurrence 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...

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

override void	Resize (int size)
	Resize to the given size 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...

void	Write (StreamWriter writer)
	Write out the correlations to a StreamWriter More...

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]`
	The number of columns of the matrix More...

int	NumberOfColumns `[get]`
	The number of columns of the matrix More...

override int	NumberOfNonEmptyEntries `[get]`

int	NumberOfRows `[get]`
	The number of rows of the matrix More...

int	NumberOfRows `[get]`
	The number of rows of the matrix More...

int	NumEntities `[get]`
	Number of entities the correlation is defined over More...

override T	this[int x, int y] `[get, set]`
	Access the elements of the sparse matrix More...

T	this[int x, int y] `[get, set]`
	The value at (i,j) More...

T	this[int x, int y] `[get, set]`
	The value at (i,j) More...

bool	Weighted `[get, set]`

Detailed Description

Class for storing and computing the co-counts

Constructor & Destructor Documentation

Cooccurrence ( int num_entities )

inline

Creates an object of type Cooccurrence

Parameters

num_entities the 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_id the 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_i	the first vector
vector_j	the 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_data the 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_rows	the number of rows
num_columns	the 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_rows	the number of rows
num_columns	the number of columns

Returns: A matrix with num_rows rows and num_column columns

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

inlineinherited

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

override void Resize ( int size )

inlineinherited

Resize to the given size

Parameters

size the size

Implements ICorrelationMatrix.

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)

void Write ( StreamWriter writer )

inlineinherited

Write out the correlations to a StreamWriter

Parameters

writer A StreamWriter

Implements ICorrelationMatrix.

Property Documentation

int NumberOfColumns

getinherited

The number of columns of the matrix

int NumberOfColumns

getinherited

The number of columns of the matrix

int NumberOfRows

getinherited

The number of rows of the matrix

int NumberOfRows

getinherited

The number of rows of the matrix

int NumEntities

getinherited

Number of entities the correlation is defined over

override T this[int x, int y]

getsetinherited

Access the elements of the sparse matrix

Parameters

x	the row ID
y	the column ID

T this[int x, int y]

getsetinherited

The value at (i,j)

Parameters

x	the row ID
y	the column ID

T this[int x, int y]

getsetinherited

The value at (i,j)

Parameters

x	the row ID
y	the column ID

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

Cooccurrence.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation