MyMediaLite  3.08
Public Member Functions | Protected Attributes | Properties
DataSet Class Reference

Abstract dataset class that implements some common functions. More...

Inheritance diagram for DataSet:
IDataSet PosOnlyFeedback< T > Ratings CombinedRatings RatingsProxy StaticRatings TimedRatings StaticByteRatings TimedRatingsProxy

List of all members.

Public Member Functions

 DataSet ()
 Default constructor.
 DataSet (IDataSet dataset)
 Create new dataset view from an existing one. Share the underlying data structures, do not copy them.
 DataSet (SerializationInfo info, StreamingContext context)
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.
virtual void GetObjectData (SerializationInfo info, StreamingContext context)
ISet< int > GetUsers (IList< int > indices)
 Get all users that are referenced by a given list of indices.
abstract void RemoveItem (int item_id)
 Remove all events related to a given item.
abstract 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.

Protected Attributes

IList< IList< int > > by_item
 Indices organized by item.
IList< IList< int > > by_user
 Indices organized by user.
IList< int > count_by_item
 field for storing the count per item
IList< int > count_by_user
 field for storing the count per user

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
virtual 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
IList< int > Items [get, set]
 the item entries
int MaxItemID [get, set]
 the maximum item ID in the dataset
int MaxUserID [get, set]
 the maximum user ID in the dataset
IList< int > RandomIndex [get]
 get a randomly ordered list of all indices
IList< int > Users [get, set]
 the user entries

Detailed Description

Abstract dataset class that implements some common functions.


Constructor & Destructor Documentation

DataSet ( ) [inline]

Default constructor.

DataSet ( IDataSet  dataset) [inline]

Create new dataset view from an existing one. Share the underlying data structures, do not copy them.

Parameters:
datasetthe dataset to build from

Member Function Documentation

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

Get index for a given user and item.

Parameters:
user_idthe user ID
item_idthe item ID
Returns:
the index of the first event encountered that matches the user ID and item ID

Implements IDataSet.

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

Get index for given user and item.

Parameters:
user_idthe user ID
item_idthe item ID
indexesthe indexes to look at
Returns:
the index of the first event encountered that matches the user ID and item ID

Implements IDataSet.

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

Get all items that are referenced by a given list of indices.

Parameters:
indicesthe indices to take into account
Returns:
all items referenced by the list of indices

Implements IDataSet.

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

Get all users that are referenced by a given list of indices.

Parameters:
indicesthe indices to take into account
Returns:
all users referenced by the list of indices

Implements IDataSet.

abstract void RemoveItem ( int  item_id) [pure virtual]

Remove all events related to a given item.

Parameters:
item_idthe item ID

Implements IDataSet.

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

abstract void RemoveUser ( int  user_id) [pure virtual]

Remove all events related to a given user.

Parameters:
user_idthe user ID

Implements IDataSet.

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

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

Try to get the index for given user and item.

Parameters:
user_idthe user ID
item_idthe item ID
indexwill 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 IDataSet.

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_idthe user ID
item_idthe item ID
indexesthe indexes to look at
indexwill 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 IDataSet.


Member Data Documentation

IList<IList<int> > by_item [protected]

Indices organized by item.

IList<IList<int> > by_user [protected]

Indices organized by user.

IList<int> count_by_item [protected]

field for storing the count per item

IList<int> count_by_user [protected]

field for storing the count per user


Property Documentation

IList<int> AllItems [get]

all item IDs in the dataset

Implements IDataSet.

IList<int> AllUsers [get]

all user IDs in the dataset

Implements IDataSet.

IList<IList<int> > ByItem [get]

indices by item

Should be implemented as a lazy data structure

Implements IDataSet.

IList<IList<int> > ByUser [get]

indices by user

Should be implemented as a lazy data structure

Implements IDataSet.

virtual int Count [get]

the number of interaction events in the dataset

Implements IDataSet.

Reimplemented in StaticRatings.

IList<int> CountByItem [get]

count by item

Should be implemented as a lazy data structure

Implements IDataSet.

IList<int> CountByUser [get]

count by user

Should be implemented as a lazy data structure

Implements IDataSet.

IList<int> Items [get, set]

the item entries

Implements IDataSet.

int MaxItemID [get, set]

the maximum item ID in the dataset

Implements IDataSet.

int MaxUserID [get, set]

the maximum user ID in the dataset

Implements IDataSet.

IList<int> RandomIndex [get]

get a randomly ordered list of all indices

Should be implemented as a lazy data structure

Implements IDataSet.

IList<int> Users [get, set]

the user entries

Implements IDataSet.


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