BinaryCosine Class Reference
Class for storing cosine similarities.
More...
List of all members.
Detailed Description
Class for storing cosine similarities.
http://en.wikipedia.org/wiki/Cosine_similarity
Constructor & Destructor Documentation
Creates an object of type Cosine.
- Parameters:
-
| num_entities | the number of entities |
Copy constructor. Creates an object of type Cosine from an existing correlation matrix.
- Parameters:
-
| correlation_matrix | the correlation matrix to copy |
Member Function Documentation
void AddEntity |
( |
int |
entity_id |
) |
[inline, inherited] |
Add an entity to the CorrelationMatrix 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 |
static float ComputeCorrelation |
( |
HashSet< int > |
vector_i, |
|
|
HashSet< int > |
vector_j | |
|
) |
| | [inline, static] |
Computes the cosine similarity of two binary vectors.
- Parameters:
-
| vector_i | the first vector |
| vector_j | the second vector |
- Returns:
- the cosine similarity between the two vectors
override void ComputeCorrelations |
( |
IBooleanMatrix |
entity_data |
) |
[inline, virtual] |
Compute the correlations from an implicit feedback, positive-only dataset.
- Parameters:
-
| entity_data | the implicit feedback set, rows contain the entities to correlate |
Reimplemented from BinaryDataCorrelationMatrix.
Creates a correlation matrix.
Gives out a useful warning if there is not enough memory
- Parameters:
-
| num_entities | the number of entities |
- Returns:
- the correlation matrix
Creates a Cosine similarity matrix from given data.
- Parameters:
-
- Returns:
- the similarity matrix based on the data
int [] GetNearestNeighbors |
( |
int |
entity_id, |
|
|
uint |
k | |
|
) |
| | [inline, inherited] |
Get the k nearest neighbors of a given entity.
- Parameters:
-
| entity_id | the numerical ID of the entity |
| k | the neighborhood size |
- Returns:
- an array containing the numerical IDs of the k nearest neighbors
IList<int> GetPositivelyCorrelatedEntities |
( |
int |
entity_id |
) |
[inline, inherited] |
Get all entities that are positively correlated to an entity, sorted by correlation.
- Parameters:
-
- Returns:
- a sorted list of all entities that are positively correlated to entitiy_id
static CorrelationMatrix ReadCorrelationMatrix |
( |
StreamReader |
reader |
) |
[inline, static, inherited] |
Creates a CorrelationMatrix from the lines of a StreamReader.
In the first line, we expect to be the number of entities. All the other lines have the format
EntityID1 EntityID2 Correlation
where EntityID1 and EntityID2 are non-negative integers and Correlation is a floating point number.
- Parameters:
-
| reader | the StreamReader to read from |
double SumUp |
( |
int |
entity_id, |
|
|
ICollection< int > |
entities | |
|
) |
| | [inline, inherited] |
Sum up the correlations between a given entity and the entities in a collection.
- Parameters:
-
| entity_id | the numerical ID of the entity |
| entities | a collection containing the numerical IDs of the entities to compare to |
- Returns:
- the correlation sum
void Write |
( |
StreamWriter |
writer |
) |
[inline, inherited] |
Write out the correlations to a StreamWriter.
- Parameters:
-
Member Data Documentation
Number of entities, e.g. users or items.
The documentation for this class was generated from the following file: