org.ranksys.fm

Class PreferenceFM<U,I>

java.lang.Object

org.ranksys.fm.PreferenceFM<U,I>

Type Parameters:

U - type of users

I - type of items

All Implemented Interfaces:

ItemIndex<I>, UserIndex<U>, FastItemIndex<I>, FastUserIndex<U>

public class PreferenceFM<U,I>
extends Object
implements FastUserIndex<U>, FastItemIndex<I>

Wraps a factorisation machine to work with RankSys user-preference pairs.

Author:

Saúl Vargas (Saul@VargasSandoval.es)

Constructor Summary

Constructors

Constructor and Description
PreferenceFM(FastUserIndex<U> users, FastItemIndex<I> items, org.ranksys.javafm.FM fm) Constructor with default converter to IdxPref.
PreferenceFM(FastUserIndex<U> users, FastItemIndex<I> items, org.ranksys.javafm.FM fm, Function<IdPref<I>,IdxPref> uPrefFun) Constructor with custom default converter to IdxPref.

Method Summary

Modifier and Type	Method and Description
boolean	containsItem(I i)
boolean	containsUser(U u)
Stream<I>	getAllItems()
Stream<U>	getAllUsers()
org.ranksys.javafm.FM	getFM() Returns the enclosed factorisation machine.
I	iidx2item(int i)
int	item2iidx(I i)
int	numItems()
int	numUsers()
double	predict(int uidx, IdxPref pref) Predicts the preference by a user to an item preference (fast version).
double	predict(U u, IdPref<I> pref) Predicts the preference by a user to an item preference.
U	uidx2user(int i)
int	user2uidx(U u)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface es.uam.eps.ir.ranksys.fast.index.FastUserIndex

getAllUidx, uidx2user, uidx2user, user2uidx, user2uidx

Methods inherited from interface es.uam.eps.ir.ranksys.fast.index.FastItemIndex

getAllIidx, iidx2item, iidx2item, item2iidx, item2iidx

Constructor Detail

PreferenceFM

public PreferenceFM(FastUserIndex<U> users,
                    FastItemIndex<I> items,
                    org.ranksys.javafm.FM fm)

Constructor with default converter to IdxPref.

Parameters:

users - user index

items - item index

fm - factorisation machine

PreferenceFM

public PreferenceFM(FastUserIndex<U> users,
                    FastItemIndex<I> items,
                    org.ranksys.javafm.FM fm,
                    Function<IdPref<I>,IdxPref> uPrefFun)

Constructor with custom default converter to IdxPref.

Parameters:

users - user index

items - item index

fm - factorisation machine

uPrefFun - converter to IdxPref

Method Detail

getFM

public org.ranksys.javafm.FM getFM()

Returns the enclosed factorisation machine.

Returns:

factorisation machine

predict

public double predict(U u,
                      IdPref<I> pref)

Predicts the preference by a user to an item preference.

Parameters:

u - user

pref - preference

Returns:

predicted score

predict

public double predict(int uidx,
                      IdxPref pref)

Predicts the preference by a user to an item preference (fast version).

Parameters:

uidx - user

pref - preference

Returns:

predicted score

user2uidx

public int user2uidx(U u)

Specified by:

user2uidx in interface FastUserIndex<U>

uidx2user

public U uidx2user(int i)

Specified by:

uidx2user in interface FastUserIndex<U>

containsUser

public boolean containsUser(U u)

Specified by:

containsUser in interface UserIndex<U>

Specified by:

containsUser in interface FastUserIndex<U>

numUsers

public int numUsers()

Specified by:

numUsers in interface UserIndex<U>

getAllUsers

public Stream<U> getAllUsers()

Specified by:

getAllUsers in interface UserIndex<U>

Specified by:

getAllUsers in interface FastUserIndex<U>

item2iidx

public int item2iidx(I i)

Specified by:

item2iidx in interface FastItemIndex<I>

iidx2item

public I iidx2item(int i)

Specified by:

iidx2item in interface FastItemIndex<I>

containsItem

public boolean containsItem(I i)

Specified by:

containsItem in interface ItemIndex<I>

Specified by:

containsItem in interface FastItemIndex<I>

numItems

public int numItems()

Specified by:

numItems in interface ItemIndex<I>

getAllItems

public Stream<I> getAllItems()

Specified by:

getAllItems in interface ItemIndex<I>

Specified by:

getAllItems in interface FastItemIndex<I>