ITimedRatings Interface Reference

Interface for rating datasets with time information. More...

Inheritance diagram for ITimedRatings:

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	Add (int user_id, int item_id, double rating, DateTime time)
	add a rating event including time information
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.
int	GetIndex (int user_id, int item_id, ICollection< int > indexes)
	Get index for given user and item.
int	GetIndex (int user_id, int item_id)
	Get index for a 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	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, 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
IList< int >	AllItems [get]
	all item IDs in the dataset
IList< 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
new int	Count [get]
	the number of interaction events in the dataset
IList< int >	CountByItem [get]
	rating count by item
IList< int >	CountByUser [get]
	rating count by user
DateTime	EarliestTime [get]
	earliest time
IList< int >	Items [get]
	the item entries
DateTime	LatestTime [get]
	latest time
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< DateTime >	Times [get]
	the item entries
IList< int >	Users [get]
	the user entries

---

Detailed Description

Interface for rating datasets with time information.

---

Member Function Documentation

void Add	(	int	user_id,
		int	item_id,
		double	rating
	)			[inherited]

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
	)			[inherited]

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
	)			[inherited]

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 Add	(	int	user_id,
		int	item_id,
		double	rating,
		DateTime	time
	)

add a rating event including time information

It is up to the user of a class implementing this interface to decide whether the DateTime object represent local time, UTC, or any other time.

Parameters:

	user_id	the user ID
	item_id	the item ID
	rating	the rating value
	time	A DateTime specifying the time of the rating event

Implemented in TimedRatings.

void BuildItemIndices

(

)

[inherited]

Build the item indices.

Implemented in DataSet.

void BuildRandomIndex

(

)

[inherited]

Build the random index.

Implemented in DataSet.

void BuildUserIndices

(

)

[inherited]

Build the user indices.

Implemented in DataSet.

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

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.

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

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

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

void RemoveItem

(

int

item_id

)

[inherited]

Remove all events related to a given item.

Parameters:

item_id

the item ID

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

void RemoveUser

(

int

user_id

)

[inherited]

Remove all events related to a given user.

Parameters:

user_id

the user ID

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

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

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
	)			[inherited]

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
	)			[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 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 Ratings.

---

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.

double Average [get, inherited]

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, inherited]

the number of interaction events in the dataset

Implements IDataSet.

Implemented in StaticRatings.

IList<int> CountByItem [get, inherited]

rating count by item

Should be implemented as a lazy data structure

Implemented in Ratings.

IList<int> CountByUser [get, inherited]

rating count by user

Should be implemented as a lazy data structure

Implemented in Ratings.

DateTime EarliestTime [get, inherited]

earliest time

Implemented in TimedRatings.

IList<int> Items [get, inherited]

the item entries

Implemented in DataSet.

DateTime LatestTime [get, inherited]

latest time

Implemented in TimedRatings.

int MaxItemID [get, inherited]

the maximum item ID in the dataset

Implemented in DataSet.

double MaxRating [get, inherited]

the maximum rating in the dataset

Implemented in Ratings.

int MaxUserID [get, inherited]

the maximum user ID in the dataset

Implemented in DataSet.

double MinRating [get, inherited]

the minimum rating in the dataset

Implemented in Ratings.

IList<int> RandomIndex [get, inherited]

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

Implemented in DataSet.

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

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

IList<DateTime> Times [get, inherited]

the item entries

Implemented in TimedRatings.

IList<int> Users [get, inherited]

the user entries

Implemented in DataSet.

---

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

• ITimedRatings.cs