IRatings Interface Reference

Interface for rating datasets. More...

Inheritance diagram for IRatings:
ITimedRatings Ratings TimedRatings CombinedRatings RatingsProxy RatingsWithDateTime StaticRatings TimedRatings StaticByteRatings StaticFloatRatings StaticRatingsWithDateTime

List of all members.

Public Member Functions

void Add (int user_id, int item_id, double rating)
 Add a new rating.
void Add (int user_id, int item_id, float rating)
 Add float-valued rating to the collection.
void Add (int user_id, int item_id, byte rating)
 Add byte-valued rating to the collection.
void BuildItemIndices ()
 Build the item indices.
void BuildRandomIndex ()
 Build the random index.
void BuildUserIndices ()
 Build the user indices.
double Get (int user_id, int item_id, ICollection< int > indexes)
 Directly access rating by user and item.
double Get (int user_id, int item_id)
 Directly access rating by user and item.
int GetIndex (int user_id, int item_id, ICollection< int > indexes)
 Get index of rating for given user and item.
int GetIndex (int user_id, int item_id)
 Get index of rating for given user and item.
HashSet< int > GetItems (IList< int > indices)
 Get all items that are referenced by a given list of indices.
HashSet< int > GetUsers (IList< int > indices)
 Get all users that are referenced by a given list of indices.
void RemoveItem (int item_id)
 Remove all ratings of a given item.
void RemoveUser (int user_id)
 Remove all ratings by a given user.
bool TryGet (int user_id, int item_id, ICollection< int > indexes, out double rating)
 Try to retrieve a rating for a given user-item combination.
bool TryGet (int user_id, int item_id, out double rating)
 Try to retrieve a rating for a given user-item combination.
bool TryGetIndex (int user_id, int item_id, ICollection< int > indexes, out int index)
 Try to get the index for given user and item.
bool TryGetIndex (int user_id, int item_id, out int index)
 Try to get the index for given user and item.

Properties

HashSet< int > AllItems [get]
 all item IDs in the dataset
HashSet< int > AllUsers [get]
 all user IDs in the dataset
double Average [get]
 average rating in the dataset
IList< IList< int > > ByItem [get]
 indices by item
IList< IList< int > > ByUser [get]
 indices by user
IList< int > CountByItem [get]
 rating count by item
IList< int > CountByUser [get]
 rating count by user
IList< int > Items [get]
 the item entries
int MaxItemID [get]
 the maximum item ID in the dataset
double MaxRating [get]
 the maximum rating in the dataset
int MaxUserID [get]
 the maximum user ID in the dataset
double MinRating [get]
 the minimum rating in the dataset
IList< int > RandomIndex [get]
 get a randomly ordered list of all indices
double this [int user_id, int item_id] [get]
 Directly access rating by user and item.
IList< int > Users [get]
 the user entries

Detailed Description

Interface for rating datasets.


Member Function Documentation

void Add ( int  user_id,
int  item_id,
double  rating 
)

Add a new rating.

Parameters:
user_id the user ID
item_id the item ID
rating the rating value

Implemented in Ratings, StaticByteRatings, StaticFloatRatings, StaticRatings, and TimedRatings.

void Add ( int  user_id,
int  item_id,
float  rating 
)

Add float-valued rating to the collection.

Parameters:
user_id the user ID
item_id the item ID
rating the rating

Implemented in Ratings, and StaticFloatRatings.

void Add ( int  user_id,
int  item_id,
byte  rating 
)

Add byte-valued rating to the collection.

Parameters:
user_id the user ID
item_id the item ID
rating the rating

Implemented in Ratings, StaticByteRatings, and StaticFloatRatings.

void BuildItemIndices (  ) 

Build the item indices.

Implemented in Ratings.

void BuildRandomIndex (  ) 

Build the random index.

Implemented in Ratings.

void BuildUserIndices (  ) 

Build the user indices.

Implemented in Ratings.

double Get ( int  user_id,
int  item_id,
ICollection< int >  indexes 
)

Directly access rating by user and item.

Parameters:
user_id the user ID
item_id the item ID
indexes the indexes to look at
Returns:
the first rating encountered that matches the user ID and item ID

Implemented in Ratings, StaticByteRatings, and StaticFloatRatings.

double Get ( int  user_id,
int  item_id 
)

Directly access rating by user and item.

Parameters:
user_id the user ID
item_id the item ID
Returns:
the first found rating of the given item by the given user

Implemented in Ratings.

int GetIndex ( int  user_id,
int  item_id,
ICollection< int >  indexes 
)

Get index of rating for given user and item.

Parameters:
user_id the user ID
item_id the item ID
indexes the indexes to look at
Returns:
the index of the first rating encountered that matches the user ID and item ID

Implemented in Ratings.

int GetIndex ( int  user_id,
int  item_id 
)

Get index of rating for given user and item.

Parameters:
user_id the user ID
item_id the item ID
Returns:
the index of the first rating encountered that matches the user ID and item ID

Implemented in Ratings.

HashSet<int> GetItems ( IList< int >  indices  ) 

Get all items that are referenced by a given list of indices.

Parameters:
indices the indices to take into account
Returns:
the set of itemss

Implemented in Ratings.

HashSet<int> GetUsers ( IList< int >  indices  ) 

Get all users that are referenced by a given list of indices.

Parameters:
indices the indices to take into account
Returns:
the set of users

Implemented in Ratings.

void RemoveItem ( int  item_id  ) 

Remove all ratings of a given item.

Parameters:
item_id the item ID

Implemented in Ratings, and StaticRatings.

void RemoveUser ( int  user_id  ) 

Remove all ratings by a given user.

Parameters:
user_id the user ID

Implemented in Ratings, and StaticRatings.

bool TryGet ( int  user_id,
int  item_id,
ICollection< int >  indexes,
out double  rating 
)

Try to retrieve a rating for a given user-item combination.

Parameters:
user_id the user ID
item_id the item ID
indexes the indexes to look at
rating will contain the first rating encountered that matches the user ID and item ID
Returns:
true if a rating was found for the user and item

Implemented in Ratings, StaticByteRatings, and StaticFloatRatings.

bool TryGet ( int  user_id,
int  item_id,
out double  rating 
)

Try to retrieve a rating for a given user-item combination.

Parameters:
user_id the user ID
item_id the item ID
rating will contain the first rating encountered that matches the user ID and item ID
Returns:
true if a rating was found for the user and item

Implemented in Ratings, StaticByteRatings, and StaticFloatRatings.

bool TryGetIndex ( int  user_id,
int  item_id,
ICollection< int >  indexes,
out int  index 
)

Try to get the index for given user and item.

Parameters:
user_id the user ID
item_id the item ID
indexes the indexes to look at
index will contain the index of the first rating encountered that matches the user ID and item ID
Returns:
true if an index was found for the user and item

Implemented in Ratings.

bool TryGetIndex ( int  user_id,
int  item_id,
out int  index 
)

Try to get the index for given user and item.

Parameters:
user_id the user ID
item_id the item ID
index will contain the index of the first rating encountered that matches the user ID and item ID
Returns:
true if an index was found for the user and item

Implemented in Ratings.


Property Documentation

HashSet<int> AllItems [get]

all item IDs in the dataset

Implemented in Ratings.

HashSet<int> AllUsers [get]

all user IDs in the dataset

Implemented in Ratings.

double Average [get]

average rating in the dataset

Implemented in Ratings.

IList<IList<int> > ByItem [get]

indices by item

Should be implemented as a lazy data structure

Implemented in Ratings.

IList<IList<int> > ByUser [get]

indices by user

Should be implemented as a lazy data structure

Implemented in Ratings.

IList<int> CountByItem [get]

rating count by item

Should be implemented as a lazy data structure

Implemented in Ratings.

IList<int> CountByUser [get]

rating count by user

Should be implemented as a lazy data structure

Implemented in Ratings.

IList<int> Items [get]

the item entries

Implemented in Ratings.

int MaxItemID [get]

the maximum item ID in the dataset

Implemented in Ratings.

double MaxRating [get]

the maximum rating in the dataset

Implemented in Ratings.

int MaxUserID [get]

the maximum user ID in the dataset

Implemented in Ratings.

double MinRating [get]

the minimum rating in the dataset

Implemented in Ratings.

IList<int> RandomIndex [get]

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

Implemented in Ratings.

double this[int user_id, int item_id] [get]

Directly access rating by user and item.

Parameters:
user_id the user ID
item_id the item ID

Implemented in Ratings, StaticByteRatings, and StaticFloatRatings.

IList<int> Users [get]

the user entries

Implemented in Ratings.


The documentation for this interface was generated from the following file:
Generated on Thu Sep 1 19:35:56 2011 for MyMediaLite by  doxygen 1.6.3