Interface for rating datasets More...

Inheritance diagram for IRatings:

Public Member Functions
void	Add (int user_id, int item_id, byte rating)
	Add byte-valued rating to the collection More...

void	Add (int user_id, int item_id, float rating)
	Add float-valued rating to the collection More...

float	Get (int user_id, int item_id, ICollection< int > indexes)
	Directly access rating by user and item More...

int	GetIndex (int user_id, int item_id)
	Get index for a given user and item More...

int	GetIndex (int user_id, int item_id, ICollection< int > indexes)
	Get index for given user and item More...

ISet< int >	GetItems (IList< int > indices)
	Get all items that are referenced by a given list of indices More...

ISet< int >	GetUsers (IList< int > indices)
	Get all users that are referenced by a given list of indices More...

void	InitScale ()
	Initialize the Scale property More...

void	RemoveItem (int item_id)
	Remove all events related to a given item More...

void	RemoveUser (int user_id)
	Remove all events related to a given user More...

bool	TryGet (int user_id, int item_id, out float rating)
	Try to retrieve a rating for a given user-item combination More...

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

bool	TryGetIndex (int user_id, int item_id, out int index)
	Try to get the index for given user and item More...

bool	TryGetIndex (int user_id, int item_id, ICollection< int > indexes, out int index)
	Try to get the index for given user and item More...

Properties
IList< int >	AllItems `[get]`
	all item IDs in the dataset More...

IList< int >	AllUsers `[get]`
	all user IDs in the dataset More...

float	Average `[get]`
	average rating in the dataset More...

IList< IList< int > >	ByItem `[get]`
	indices by item More...

IList< IList< int > >	ByUser `[get]`
	indices by user More...

new int	Count `[get]`

IList< int >	CountByItem `[get]`
	count by item More...

IList< int >	CountByUser `[get]`
	count by user More...

IList< int >	Items `[get]`
	the item entries More...

int	MaxItemID `[get]`
	the maximum item ID in the dataset More...

int	MaxUserID `[get]`
	the maximum user ID in the dataset More...

IList< int >	RandomIndex `[get]`
	get a randomly ordered list of all indices More...

RatingScale	Scale `[get]`
	information about the scale of the ratings in the dataset More...

float	this[int user_id, int item_id] `[get]`
	Directly access rating by user and item More...

IList< int >	Users `[get]`
	the user entries More...

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

getinherited

all item IDs in the dataset

IList<int> AllUsers

getinherited

all user IDs in the dataset

float Average

get

average rating in the dataset

IList<IList<int> > ByItem

getinherited

indices by item

Should be implemented as a lazy data structure

IList<IList<int> > ByUser

getinherited

indices by user

Should be implemented as a lazy data structure

IList<int> CountByItem

getinherited

count by item

Should be implemented as a lazy data structure

IList<int> CountByUser

getinherited

count by user

Should be implemented as a lazy data structure

IList<int> Items

getinherited

the item entries

int MaxItemID

getinherited

the maximum item ID in the dataset

int MaxUserID

getinherited

the maximum user ID in the dataset

IList<int> RandomIndex

getinherited

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

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

Parameters

user_id	the user ID
item_id	the item ID

the rating value for the given user and item

IList<int> Users

getinherited

the user entries

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

IRatings.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation