MyMediaLite  3.11
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
StaticByteRatings Class Reference

Array-based storage for rating data. More...

Inheritance diagram for StaticByteRatings:
StaticRatings Ratings DataSet IRatings IDataSet IDataSet

Public Member Functions

override void Add (int user_id, int item_id, float rating)
 Add float-valued rating to the collection More...
 
override void Add (int user_id, int item_id, byte rating)
 Add byte-valued rating to the collection More...
 
void Add (float item)
 
void Clear ()
 
bool Contains (float item)
 
void CopyTo (float[] array, int index)
 
override float Get (int user_id, int item_id, ICollection< int > indexes)
 Directly access rating by user and item More...
 
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...
 
override void GetObjectData (SerializationInfo info, StreamingContext context)
 
ISet< int > GetUsers (IList< int > indices)
 Get all users that are referenced by a given list of indices More...
 
int IndexOf (float item)
 
override void InitScale ()
 Initialize the Scale property More...
 
void Insert (int index, float item)
 
bool Remove (float item)
 
override void RemoveAt (int index)
 
override void RemoveItem (int item_id)
 Remove all events related to a given item More...
 
override void RemoveUser (int user_id)
 Remove all events related to a given user More...
 
 StaticByteRatings (int size)
 
 StaticByteRatings (SerializationInfo info, StreamingContext context)
 
override bool TryGet (int user_id, int item_id, out float rating)
 Try to retrieve a rating for a given user-item combination More...
 
override bool TryGet (int user_id, int item_id, ICollection< int > indexes, out float rating)
 Try to retrieve a rating for a given user-item combination 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...
 

Protected Member Functions

void UpdateCountsAndIndices (ISet< int > users, ISet< int > items)
 update user- and item-wise counts and indices More...
 

Protected Attributes

IList< IList< int > > by_item
 Indices organized by item More...
 
IList< IList< int > > by_user
 Indices organized by user More...
 
IList< int > count_by_item
 field for storing the count per item More...
 
IList< int > count_by_user
 field for storing the count per user More...
 
int pos = 0
 The position where the next rating will be stored More...
 
IList< float > Values
 

Properties

IList< int > AllItems [get]
 
IList< int > AllUsers [get]
 
float Average [get]
 
IList< IList< int > > ByItem [get]
 
IList< IList< int > > ByUser [get]
 
override int Count [get]
 
IList< int > CountByItem [get]
 
IList< int > CountByUser [get]
 
bool IsReadOnly [get]
 
IList< int > Items [get, protected set]
 
int MaxItemID [get, protected set]
 
int MaxUserID [get, protected set]
 
IList< int > RandomIndex [get]
 
RatingScale Scale [get, protected set]
 
override float this[int index] [get, set]
 
override float this[int user_id, int item_id] [get]
 
IList< int > Users [get, protected set]
 

Detailed Description

Array-based storage for rating data.

Very memory-efficient.

This data structure does NOT support incremental updates.

Member Function Documentation

override void Add ( int  user_id,
int  item_id,
float  rating 
)
inlinevirtual

Add float-valued rating to the collection

Parameters
user_idthe user ID
item_idthe item ID
ratingthe rating

Reimplemented from Ratings.

override void Add ( int  user_id,
int  item_id,
byte  rating 
)
inlinevirtual

Add byte-valued rating to the collection

Parameters
user_idthe user ID
item_idthe item ID
ratingthe rating

Reimplemented from Ratings.

override float Get ( int  user_id,
int  item_id,
ICollection< int >  indexes 
)
inlinevirtual

Directly access rating by user and item

Parameters
user_idthe user ID
item_idthe item ID
indexesthe indexes to look at
Returns
the first rating encountered that matches the user ID and item ID

Reimplemented from Ratings.

int GetIndex ( int  user_id,
int  item_id 
)
inlineinherited

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

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

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

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.

override void InitScale ( )
inlinevirtual

Initialize the Scale property

Reimplemented from Ratings.

override void RemoveItem ( int  item_id)
inlinevirtualinherited

Remove all events related to a given item

Parameters
item_idthe item ID

Reimplemented from Ratings.

override void RemoveUser ( int  user_id)
inlinevirtualinherited

Remove all events related to a given user

Parameters
user_idthe user ID

Reimplemented from Ratings.

override bool TryGet ( int  user_id,
int  item_id,
out float  rating 
)
inlinevirtual

Try to retrieve a rating for a given user-item combination

Parameters
user_idthe user ID
item_idthe item ID
ratingwill contain the first rating encountered that matches the user ID and item ID
Returns
true if a rating was found for the user and item

Reimplemented from Ratings.

override bool TryGet ( int  user_id,
int  item_id,
ICollection< int >  indexes,
out float  rating 
)
inlinevirtual

Try to retrieve a rating for a given user-item combination

Parameters
user_idthe user ID
item_idthe item ID
indexesthe indexes to look at
ratingwill contain the first rating encountered that matches the user ID and item ID
Returns
true if a rating was found for the user and item

Reimplemented from Ratings.

bool TryGetIndex ( int  user_id,
int  item_id,
out int  index 
)
inlineinherited

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

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.

void UpdateCountsAndIndices ( ISet< int >  users,
ISet< int >  items 
)
inlineprotectedinherited

update user- and item-wise counts and indices

Parameters
usersthe modified users
itemsthe modified itemsItems.

Member Data Documentation

IList<IList<int> > by_item
protectedinherited

Indices organized by item

IList<IList<int> > by_user
protectedinherited

Indices organized by user

IList<int> count_by_item
protectedinherited

field for storing the count per item

IList<int> count_by_user
protectedinherited

field for storing the count per user

int pos = 0
protectedinherited

The position where the next rating will be stored


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