Interface for implicit, positive-only user feedback
More...
Public Member Functions |
void | Add (int user_id, int item_id) |
| Add a user-item event to the data structure
|
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
|
IBooleanMatrix | GetItemMatrixCopy () |
| Get a copy of the item matrix
|
ISet< int > | GetItems (IList< int > indices) |
| Get all items that are referenced by a given list of indices
|
IBooleanMatrix | GetUserMatrixCopy () |
| Get a copy of the user matrix
|
ISet< int > | GetUsers (IList< int > indices) |
| Get all users that are referenced by a given list of indices
|
void | Remove (int user_id, int item_id) |
| Remove a user-item event from the data structure
|
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
|
IPosOnlyFeedback | Transpose () |
| Get the transpose of the dataset (users and items exchanged)
|
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
|
IBooleanMatrix | ItemMatrix [get] |
| By-item access, items are stored in the rows, users in the culumns
|
IList< int > | Items [get] |
| the item entries
|
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
|
IBooleanMatrix | UserMatrix [get] |
| By-user access, users are stored in the rows, items in the culumns
|
IList< int > | Users [get] |
| the user entries
|
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_id | the user ID |
item_id | the 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_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 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_id | the user ID |
item_id | the item ID |
Implemented in PosOnlyFeedback< T >.
void RemoveItem |
( |
int |
item_id | ) |
|
|
inherited |
void RemoveUser |
( |
int |
user_id | ) |
|
|
inherited |
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_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
all item IDs in the dataset
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
the number of interaction events in the dataset
count by item
Should be implemented as a lazy data structure
count by user
Should be implemented as a lazy data structure
By-item access, items are stored in the rows, users in the culumns
should be implemented as lazy data structure
the maximum item ID in the dataset
the maximum user ID in the dataset
get a randomly ordered list of all indices
Should be implemented as a lazy data structure
By-user access, users are stored in the rows, items in the culumns
should be implemented as lazy data structure
The documentation for this interface was generated from the following file: