interface for data sets with time information More...

Inheritance diagram for ITimedDataSet:

Public Member Functions
int	GetIndex (int user_id, int item_id)
	Get index for a given user and item
int	GetIndex (int user_id, int item_id, ICollection< int > indexes)
	Get index for 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, out int index)
	Try to get the index for given user and item
bool	TryGetIndex (int user_id, int item_id, ICollection< int > indexes, 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 >	CountByItem `[get]`
	count by item
IList< int >	CountByUser `[get]`
	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
int	MaxUserID `[get]`
	the maximum user ID in the dataset
IList< int >	RandomIndex `[get]`
	get a randomly ordered list of all indices
IList< DateTime >	Times `[get]`
	the item entries
IList< int >	Users `[get]`
	the user entries

Detailed Description

interface for data sets with time information

Member Function Documentation

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

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

int Count

getinherited

the number of interaction events in the dataset

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

DateTime EarliestTime

get

earliest time

IList<int> Items

getinherited

the item entries

DateTime LatestTime

get

latest time

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

IList<DateTime> Times

get

the item entries

IList<int> Users

getinherited

the user entries

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

ITimedDataSet.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation