MyMediaLite  3.11
Public Member Functions | Properties | List of all members
IPosOnlyFeedback Interface Reference

Interface for implicit, positive-only user feedback More...

Inheritance diagram for IPosOnlyFeedback:
IDataSet PosOnlyFeedback< T >

Public Member Functions

void Add (int user_id, int item_id)
 Add a user-item event to the data structure 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...
 
IBooleanMatrix GetItemMatrixCopy ()
 Get a copy of the item matrix More...
 
ISet< int > GetItems (IList< int > indices)
 Get all items that are referenced by a given list of indices More...
 
IBooleanMatrix GetUserMatrixCopy ()
 Get a copy of the user matrix More...
 
ISet< int > GetUsers (IList< int > indices)
 Get all users that are referenced by a given list of indices More...
 
void Remove (int user_id, int item_id)
 Remove a user-item event from the data structure 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...
 
IPosOnlyFeedback Transpose ()
 Get the transpose of the dataset (users and items exchanged) 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...
 
IBooleanMatrix ItemMatrix [get]
 By-item access, items are stored in the rows, users in the culumns 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...
 
IBooleanMatrix UserMatrix [get]
 By-user access, users are stored in the rows, items in the culumns More...
 
IList< int > Users [get]
 the user entries More...
 

Detailed Description

Interface for implicit, positive-only user feedback

Member Function Documentation

void Add ( int  user_id,
int  item_id 
)

Add a user-item event to the data structure

Parameters
user_idthe user ID
item_idthe item ID

Implemented in PosOnlyFeedback< T >.

int GetIndex ( int  user_id,
int  item_id 
)
inherited

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

Implemented in DataSet.

int GetIndex ( int  user_id,
int  item_id,
ICollection< int >  indexes 
)
inherited

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

Implemented in DataSet.

IBooleanMatrix GetItemMatrixCopy ( )

Get a copy of the item matrix

Returns
a copy of the item matrix

Implemented in PosOnlyFeedback< T >.

ISet<int> GetItems ( IList< int >  indices)
inherited

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

Implemented in DataSet.

IBooleanMatrix GetUserMatrixCopy ( )

Get a copy of the user matrix

Returns
a copy of the user matrix

Implemented in PosOnlyFeedback< T >.

ISet<int> GetUsers ( IList< int >  indices)
inherited

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

Implemented in DataSet.

void Remove ( int  user_id,
int  item_id 
)

Remove a user-item event from the data structure

If no event for the given user-item combination exists, nothing happens.

Parameters
user_idthe user ID
item_idthe item ID

Implemented in PosOnlyFeedback< T >.

void RemoveItem ( int  item_id)
inherited

Remove all events related to a given item

Parameters
item_idthe 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_idthe user ID

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

IPosOnlyFeedback Transpose ( )

Get the transpose of the dataset (users and items exchanged)

Returns
the transpose of the dataset

Implemented in PosOnlyFeedback< T >.

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

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

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

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

IBooleanMatrix ItemMatrix
get

By-item access, items are stored in the rows, users in the culumns

should be implemented as lazy data structure

IList<int> Items
getinherited

the item entries

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

IBooleanMatrix UserMatrix
get

By-user access, users are stored in the rows, items in the culumns

should be implemented as lazy data structure

IList<int> Users
getinherited

the user entries


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