Ratings Class Reference

Data structure for storing ratings. More...

Inheritance diagram for Ratings:

Public Member Functions
void	Add (double item)
virtual void	Add (int user_id, int item_id, double rating)
	Add a new rating.
virtual void	Add (int user_id, int item_id, byte rating)
	Add byte-valued rating to the collection.
virtual void	Add (int user_id, int item_id, float rating)
	Add float-valued rating to the collection.
void	BuildByItemCounts ()
void	BuildByUserCounts ()
void	BuildItemIndices ()
	Build the item indices.
void	BuildRandomIndex ()
	Build the random index.
void	BuildUserIndices ()
	Build the user indices.
void	Clear ()
bool	Contains (double item)
void	CopyTo (double[] array, int index)
virtual 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.
int	IndexOf (double item)
void	Insert (int index, double item)
	Ratings ()
	Default constructor.
bool	Remove (double item)
virtual void	RemoveAt (int index)
override void	RemoveItem (int item_id)
	Remove all events related to a given item.
override void	RemoveUser (int user_id)
	Remove all events related to a given user.
virtual 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.
virtual 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.
Protected Attributes
IList< IList< int > >	by_item
	Indices organized by item.
IList< IList< int > >	by_user
	Indices organized by user.
IList< double >	Values
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
virtual 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
bool	IsReadOnly `[get]`
IList< int >	Items `[get, set]`
	the item entries
int	MaxItemID `[get, set]`
	the maximum item ID in the dataset
double	MaxRating `[get, set]`
	the maximum rating in the dataset
int	MaxUserID `[get, set]`
	the maximum user ID in the dataset
double	MinRating `[get, set]`
	the minimum rating in the dataset
IList< int >	RandomIndex `[get]`
	get a randomly ordered list of all indices
virtual double	this [int index] `[get, set]`
	Directly access rating by user and item.
IList< int >	Users `[get, set]`
	the user entries

Detailed Description

Data structure for storing ratings.

Small memory overhead for added flexibility.

This data structure supports incremental updates.

Constructor & Destructor Documentation

Ratings ( ) [inline]

Default constructor.

Member Function Documentation

virtual void Add	(	int	user_id,
		int	item_id,
		double	rating
	)			`[inline, virtual]`

Add a new rating.

Parameters:

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

Implements IRatings.

Reimplemented in StaticByteRatings, StaticFloatRatings, StaticRatings, and TimedRatings.

virtual void Add	(	int	user_id,
		int	item_id,
		byte	rating
	)			`[inline, virtual]`

Add byte-valued rating to the collection.

Parameters:

	user_id	the user ID
	item_id	the item ID
	rating	the rating

Implements IRatings.

Reimplemented in StaticByteRatings, and StaticFloatRatings.

virtual void Add	(	int	user_id,
		int	item_id,
		float	rating
	)			`[inline, virtual]`

Add float-valued rating to the collection.

Parameters:

	user_id	the user ID
	item_id	the item ID
	rating	the rating

Implements IRatings.

Reimplemented in StaticFloatRatings.

void BuildItemIndices ( ) [inline, inherited]

Build the item indices.

Implements IDataSet.

void BuildRandomIndex ( ) [inline, inherited]

Build the random index.

Implements IDataSet.

void BuildUserIndices ( ) [inline, inherited]

Build the user indices.

Implements IDataSet.

virtual double Get	(	int	user_id,
		int	item_id,
		ICollection< int >	indexes
	)			`[inline, virtual]`

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

Implements IRatings.

Reimplemented in StaticByteRatings, and StaticFloatRatings.

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

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

Implements IRatings.

int GetIndex	(	int	user_id,
		int	item_id
	)			`[inline]`

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

Implements IRatings.

ISet<int> GetItems ( IList< int > indices ) [inline]

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

Implements IRatings.

ISet<int> GetUsers ( IList< int > indices ) [inline]

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

Implements IRatings.

override void RemoveItem ( int item_id ) [inline, virtual]

Remove all events related to a given item.

Parameters:

item_id

the item ID

Implements DataSet.

Reimplemented in StaticRatings.

override void RemoveUser ( int user_id ) [inline, virtual]

Remove all events related to a given user.

Parameters:

user_id

the user ID

Implements DataSet.

Reimplemented in StaticRatings.

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

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

Implements IRatings.

Reimplemented in StaticByteRatings, and StaticFloatRatings.

virtual bool TryGet	(	int	user_id,
		int	item_id,
		out double	rating
	)			`[inline, virtual]`

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

Implements IRatings.

Reimplemented in StaticByteRatings, and StaticFloatRatings.

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

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

Implements IRatings.

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

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

Implements IRatings.

Member Data Documentation

IList<IList<int> > by_item [protected, inherited]

Indices organized by item.

IList<IList<int> > by_user [protected, inherited]

Indices organized by user.

Property Documentation

IList<int> AllItems [get, inherited]

all item IDs in the dataset

Implements IDataSet.

IList<int> AllUsers [get, inherited]

all user IDs in the dataset

Implements IDataSet.

double Average [get]

average rating in the dataset

Implements IRatings.

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

indices by item

Should be implemented as a lazy data structure

Implements IDataSet.

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

indices by user

Should be implemented as a lazy data structure

Implements IDataSet.

new int Count [get, inherited]

the number of interaction events in the dataset

Implements IDataSet.

Implemented in StaticRatings.

virtual int Count [get, inherited]

the number of interaction events in the dataset

Implements IDataSet.

Reimplemented in StaticRatings.

IList<int> CountByItem [get]

rating count by item

Should be implemented as a lazy data structure

Implements IRatings.

IList<int> CountByUser [get]

rating count by user

Should be implemented as a lazy data structure

Implements IRatings.

IList<int> Items [get, set, inherited]

the item entries

Implements IDataSet.

int MaxItemID [get, set, inherited]

the maximum item ID in the dataset

Implements IDataSet.

double MaxRating [get, set]

the maximum rating in the dataset

Implements IRatings.

int MaxUserID [get, set, inherited]

the maximum user ID in the dataset

Implements IDataSet.

double MinRating [get, set]

the minimum rating in the dataset

Implements IRatings.

IList<int> RandomIndex [get, inherited]

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

Implements IDataSet.

double this [get, set]

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

Implements IRatings.

Reimplemented in StaticByteRatings, and StaticFloatRatings.

IList<int> Users [get, set, inherited]

the user entries

Implements IDataSet.

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

Data/Ratings.cs

Ratings Class Reference

Public Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation