Class for computing and storing correlations and similarities
More...
Public Member Functions |
void | AddEntity (int entity_id) |
| Add an entity to the ICorrelationMatrix by growing it to the requested size.
|
override IMatrix< T > | CreateMatrix (int num_rows, int num_columns) |
| Create a matrix with a given number of rows and columns
|
override void | Resize (int size) |
| 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
|
| SymmetricCorrelationMatrix (int num_entities) |
| Creates a CorrelationMatrix object for a given number of entities
|
| SymmetricSparseMatrix (int dimension) |
| Create a symmetric sparse matrix with a given dimension
|
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
|
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, set] |
override int | NumberOfNonEmptyEntries [get] |
int | NumberOfRows [get] |
int | NumEntities [get, set] |
| Number of entities the correlation is defined over
|
override 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
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.
override 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
Reimplemented from SparseMatrix< T >.
Reimplemented in SkewSymmetricSparseMatrix.
override void Resize |
( |
int |
size | ) |
|
|
inline |
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 |
Implements IMatrix< T >.
SparseMatrix |
( |
int |
num_rows, |
|
|
int |
num_cols |
|
) |
| |
|
inlineinherited |
Create a sparse matrix with a given number of rows
- Parameters
-
num_rows | the number of rows |
num_cols | the number of columns |
SymmetricSparseMatrix |
( |
int |
dimension | ) |
|
|
inlineinherited |
Create a symmetric sparse matrix with a given dimension
- Parameters
-
dimension | the dimension (number of rows/columns) |
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)
Implements IMatrix< T >.
void Write |
( |
StreamWriter |
writer | ) |
|
|
inline |
Property Documentation
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 |
Dictionary<int, T> this[int x] |
|
getinherited |
Get a row of the matrix
- Parameters
-
The documentation for this class was generated from the following file:
- SymmetricCorrelationMatrix.cs