ITimedDataSet Interface Reference

interface for data sets with time information More...

Inheritance diagram for ITimedDataSet:
IDataSet ITimedRatings TimedRatings TimedRatingsProxy

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

void BuildItemIndices (  )  [inherited]

Build the item indices.

Implemented in DataSet.

void BuildRandomIndex (  )  [inherited]

Build the random index.

Implemented in DataSet.

void BuildUserIndices (  )  [inherited]

Build the user indices.

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.

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.

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

void RemoveUser ( int  user_id  )  [inherited]

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 
) [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.

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.


Property Documentation

IList<int> AllItems [get, inherited]

all item IDs in the dataset

Implemented in DataSet.

IList<int> AllUsers [get, inherited]

all user IDs in the dataset

Implemented in DataSet.

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

indices by item

Should be implemented as a lazy data structure

Implemented in DataSet.

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

indices by user

Should be implemented as a lazy data structure

Implemented in DataSet.

int Count [get, inherited]

the number of interaction events in the dataset

Implemented in DataSet, IRatings, and StaticRatings.

DateTime EarliestTime [get]

earliest time

Implemented in TimedRatings.

IList<int> Items [get, inherited]

the item entries

Implemented in DataSet.

DateTime LatestTime [get]

latest time

Implemented in TimedRatings.

int MaxItemID [get, inherited]

the maximum item ID in the dataset

Implemented in DataSet.

int MaxUserID [get, inherited]

the maximum user ID in the dataset

Implemented in DataSet.

IList<int> RandomIndex [get, inherited]

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

Implemented in DataSet.

IList<DateTime> Times [get]

the item entries

Implemented in TimedRatings.

IList<int> Users [get, inherited]

the user entries

Implemented in DataSet.


The documentation for this interface was generated from the following file:
Generated on Thu Apr 5 01:11:31 2012 for MyMediaLite by  doxygen 1.6.3