IRatings Interface Reference

Interface for rating datasets. More...

Inheritance diagram for IRatings:

List of all members.

Public Member Functions
void	Add (int user_id, int item_id, byte rating)
	Add byte-valued rating to the collection.
void	Add (int user_id, int item_id, float rating)
	Add float-valued rating to the collection.
float	Get (int user_id, int item_id, ICollection< int > indexes)
	Directly access rating by user and item.
int	GetIndex (int user_id, int item_id)
	Get index for a given user and item.
int	GetIndex (int user_id, int item_id, ICollection< int > indexes)
	Get index for given user and item.
ISet< int >	GetItems (IList< int > indices)
	Get all items that are referenced by a given list of indices.
ISet< int >	GetUsers (IList< int > indices)
	Get all users that are referenced by a given list of indices.
void	InitScale ()
	Initialize the Scale property.
void	RemoveItem (int item_id)
	Remove all events related to a given item.
void	RemoveUser (int user_id)
	Remove all events related to a given user.
bool	TryGet (int user_id, int item_id, out float rating)
	Try to retrieve a rating for a given user-item combination.
bool	TryGet (int user_id, int item_id, ICollection< int > indexes, out float rating)
	Try to retrieve a rating for a given user-item combination.
bool	TryGetIndex (int user_id, int item_id, out int index)
	Try to get the index for given user and item.
bool	TryGetIndex (int user_id, int item_id, ICollection< int > indexes, out int index)
	Try to get the index for given user and item.
Properties
IList< int >	AllItems [get]
	all item IDs in the dataset
IList< int >	AllUsers [get]
	all user IDs in the dataset
float	Average [get]
	average rating in the dataset
IList< IList< int > >	ByItem [get]
	indices by item
IList< IList< int > >	ByUser [get]
	indices by user
new int	Count [get]
	the number of interaction events in the dataset
IList< int >	CountByItem [get]
	count by item
IList< int >	CountByUser [get]
	count by user
IList< int >	Items [get]
	the item entries
int	MaxItemID [get]
	the maximum item ID in the dataset
int	MaxUserID [get]
	the maximum user ID in the dataset
IList< int >	RandomIndex [get]
	get a randomly ordered list of all indices
RatingScale	Scale [get]
	information about the scale of the ratings in the dataset
float	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,
		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, and StaticByteRatings.

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, StaticByteRatings, StaticRatings, and TimedRatings.

float 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 StaticByteRatings, and Ratings.

int GetIndex	(	int	user_id,
		int	item_id
	)		[inherited]

Get index for a given user and item.

Parameters:

user_id	the user ID
item_id	the item ID

Returns:

the index of the first event encountered that matches the user ID and item ID

Implemented in DataSet.

int GetIndex	(	int	user_id,
		int	item_id,
		ICollection< int >	indexes
	)		[inherited]

Get index 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 event encountered that matches the user ID and item ID

Implemented in DataSet.

ISet<int> GetItems

(

IList< int >

indices

)

[inherited]

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

Parameters:

indices

the indices to take into account

Returns:

all items referenced by the list of indices

Implemented in DataSet.

ISet<int> GetUsers

(

IList< int >

indices

)

[inherited]

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

Parameters:

indices

the indices to take into account

Returns:

all users referenced by the list of indices

Implemented in DataSet.

void InitScale

(

)

Initialize the Scale property.

Implemented in Ratings, and StaticByteRatings.

void RemoveItem

(

int

item_id

)

[inherited]

Remove all events related to a given item.

Parameters:

item_id

the item ID

Implemented in Ratings, DataSet, PosOnlyFeedback< T >, StaticRatings, and RatingsProxy.

void RemoveUser

(

int

user_id

)

[inherited]

Remove all events related to a given user.

Parameters:

user_id

the user ID

Implemented in Ratings, DataSet, PosOnlyFeedback< T >, StaticRatings, and RatingsProxy.

bool TryGet	(	int	user_id,
		int	item_id,
		out float	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 StaticByteRatings, and Ratings.

bool TryGet	(	int	user_id,
		int	item_id,
		ICollection< int >	indexes,
		out float	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 StaticByteRatings, and Ratings.

bool TryGetIndex	(	int	user_id,
		int	item_id,
		out int	index
	)		[inherited]

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 event encountered that matches the user ID and item ID

Returns:

true if an index was found for the user and item

Implemented in DataSet.

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

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 event encountered that matches the user ID and item ID

Returns:

true if an index was found for the user and item

Implemented in DataSet.

---

Property Documentation

IList<int> AllItems [get, inherited]

all item IDs in the dataset

Implemented in DataSet.

IList<int> AllUsers [get, inherited]

all user IDs in the dataset

Implemented in DataSet.

float Average [get]

average rating in the dataset

Implemented in Ratings.

IList<IList<int> > ByItem [get, inherited]

indices by item

Should be implemented as a lazy data structure

Implemented in DataSet.

IList<IList<int> > ByUser [get, inherited]

indices by user

Should be implemented as a lazy data structure

Implemented in DataSet.

new int Count [get]

the number of interaction events in the dataset

Implements IDataSet.

Implemented in StaticRatings.

IList<int> CountByItem [get, inherited]

count by item

Should be implemented as a lazy data structure

Implemented in DataSet.

IList<int> CountByUser [get, inherited]

count by user

Should be implemented as a lazy data structure

Implemented in DataSet.

IList<int> Items [get, inherited]

the item entries

Implemented in DataSet.

int MaxItemID [get, inherited]

the maximum item ID in the dataset

Implemented in DataSet.

int MaxUserID [get, inherited]

the maximum user ID in the dataset

Implemented in DataSet.

IList<int> RandomIndex [get, inherited]

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

Implemented in DataSet.

RatingScale Scale [get]

information about the scale of the ratings in the dataset

Implemented in Ratings.

float 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

the rating value for the given user and item

Implemented in Ratings, and StaticByteRatings.

IList<int> Users [get, inherited]

the user entries

Implemented in DataSet.

---

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

• IRatings.cs