IDataSet Interface Reference

Interface for different kinds of collaborative filtering data sets. More...

Inheritance diagram for IDataSet:

List of all members.

Public Member Functions
void	BuildItemIndices ()
	Build the item indices.
void	BuildRandomIndex ()
	Build the random index.
void	BuildUserIndices ()
	Build the user indices.
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	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
IList< IList< int > >	ByItem [get]
	indices by item
IList< IList< int > >	ByUser [get]
	indices by user
int	Count [get]
	the number of interaction events in the dataset
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
IList< int >	Users [get]
	the user entries

---

Detailed Description

Interface for different kinds of collaborative filtering data sets.

Implementing classes/inheriting interfaces are e.g. for rating data and for positive-only implicit feedback.

The main feature of a dataset is that it has some kind of order (not explicitly stated)

• random, chronological, user-wise, or item-wise - and that it contains tuples of users and items (not necessarily unique tuples).

Implementing classes and inheriting interfaces can add additional data to each user-item tuple, e.g. the date/time of an event, location, context, etc., as well as additional index structures to access the dataset in a certain fashion.

---

Member Function Documentation

void BuildItemIndices

(

)

Build the item indices.

Implemented in DataSet.

void BuildRandomIndex

(

)

Build the random index.

Implemented in DataSet.

void BuildUserIndices

(

)

Build the user indices.

Implemented in DataSet.

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

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.

int GetIndex	(	int	user_id,
		int	item_id
	)

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.

ISet<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:

all items referenced by the list of indices

Implemented in DataSet.

ISet<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:

all users referenced by the list of indices

Implemented in DataSet.

void RemoveItem

(

int

item_id

)

Remove all events related to a given item.

Parameters:

item_id

the item ID

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

void RemoveUser

(

int

user_id

)

Remove all events related to a given user.

Parameters:

user_id

the user ID

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

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

all item IDs in the dataset

Implemented in DataSet.

IList<int> AllUsers [get]

all user IDs in the dataset

Implemented in DataSet.

IList<IList<int> > ByItem [get]

indices by item

Should be implemented as a lazy data structure

Implemented in DataSet.

IList<IList<int> > ByUser [get]

indices by user

Should be implemented as a lazy data structure

Implemented in DataSet.

int Count [get]

the number of interaction events in the dataset

Implemented in DataSet, IRatings, and StaticRatings.

IList<int> Items [get]

the item entries

Implemented in DataSet.

int MaxItemID [get]

the maximum item ID in the dataset

Implemented in DataSet.

int MaxUserID [get]

the maximum user ID in the dataset

Implemented in DataSet.

IList<int> RandomIndex [get]

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

Implemented in DataSet.

IList<int> Users [get]

the user entries

Implemented in DataSet.

---

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

• IDataSet.cs