IDataSet Interface Reference

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

Inheritance diagram for IDataSet:

Public Member Functions
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	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	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...
IList< IList< int > >	ByItem [get]
	indices by item More...
IList< IList< int > >	ByUser [get]
	indices by user More...
int	Count [get]
	the number of interaction events in the dataset More...
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...
IList< int >	Users [get]
	the user entries More...

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

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.

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.

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 Ratings, DataSet, PosOnlyFeedback< T >, StaticRatings, and RatingsProxy.

void RemoveUser

(

int

user_id

)

Remove all events related to a given user

Parameters

user_id

the user ID

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

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.

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.

Property Documentation

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

Should be implemented as a lazy data structure

IList<IList<int> > ByUser

get

indices by user

Should be implemented as a lazy data structure

int Count

get

the number of interaction events in the dataset

IList<int> CountByItem

get

count by item

Should be implemented as a lazy data structure

IList<int> CountByUser

get

count by user

Should be implemented as a lazy data structure

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

Should be implemented as a lazy data structure

IList<int> Users

get

the user entries

---

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

• IDataSet.cs