org.ranksys.compression.preferences

Class RatingCODECPreferenceData<U,I,Cu,Ci,Cv>

java.lang.Object

es.uam.eps.ir.ranksys.fast.preference.AbstractFastPreferenceData<U,I>

org.ranksys.fast.preference.IteratorsAbstractFastPreferenceData<U,I>

org.ranksys.compression.preferences.AbstractCODECPreferenceData<U,I,Cu,Ci>

org.ranksys.compression.preferences.RatingCODECPreferenceData<U,I,Cu,Ci,Cv>

Type Parameters:

U - type of users

I - type of items

Cu - coding for user identifiers

Ci - coding for item identifiers

Cv - coding for ratings

All Implemented Interfaces:

ItemIndex<I>, UserIndex<U>, PreferenceData<U,I>, FastItemIndex<I>, FastUserIndex<U>, FastPreferenceData<U,I>, Serializable

public class RatingCODECPreferenceData<U,I,Cu,Ci,Cv>
extends AbstractCODECPreferenceData<U,I,Cu,Ci>

PreferenceData for rating data using compression.
If you use this code, please cite the following papers:

• Vargas, S., Macdonald, C., Ounis, I. (2015). Analysing Compression Techniques for In-Memory Collaborative Filtering. In Poster Proceedings of the 9th ACM Conference on Recommender Systems. http://ceur-ws.org/Vol-1441/recsys2015_poster2.pdf.
• Catena, M., Macdonald, C., Ounis, I. (2014). On Inverted Index Compression for Search Engine Efficiency. In ECIR (pp. 359–371). doi:10.1007/978-3-319-06028-6_30

The code that reproduces the results of the RecSys 2015 poster by Vargas et al. in a separated project: http://github.com/saulvargas/recsys2015
The search index compression technologies of the ECIR paper by Catena et al. is part of the Terrier IR Platform: http://terrier.org/docs/v4.0/compression.html.

Author:

Saúl Vargas (Saul.Vargas@glasgow.ac.uk)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Cv[]	i_vs list ratings for items.
protected CODEC<Cv>	r_codec CODEC for ratings.
protected Cv[]	u_vs list of ratings for users.

Fields inherited from class org.ranksys.compression.preferences.AbstractCODECPreferenceData

i_codec, i_idxs, i_len, u_codec, u_idxs, u_len

Fields inherited from class es.uam.eps.ir.ranksys.fast.preference.AbstractFastPreferenceData

ii, iPrefFun, ui, uPrefFun

Constructor Summary

Constructors

Modifier	Constructor and Description
	RatingCODECPreferenceData(FastPreferenceData<U,I> preferences, FastUserIndex<U> users, FastItemIndex<I> items, CODEC<Cu> u_codec, CODEC<Ci> i_codec, CODEC<Cv> r_codec) Constructor that utilizes other PreferenceData object with default IdxPref to IdPref converters.
	RatingCODECPreferenceData(FastPreferenceData<U,I> preferences, FastUserIndex<U> users, FastItemIndex<I> items, CODEC<Cu> u_codec, CODEC<Ci> i_codec, CODEC<Cv> r_codec, Function<IdxPref,IdPref<I>> uPrefFun, Function<IdxPref,IdPref<U>> iPrefFun) Constructor that utilizes other PreferenceData object with custom IdxPref to IdPref converters.
protected	RatingCODECPreferenceData(FastUserIndex<U> users, FastItemIndex<I> items, CODEC<Cu> u_codec, CODEC<Ci> i_codec, CODEC<Cv> r_codec, Function<IdxPref,IdPref<I>> uPrefFun, Function<IdxPref,IdPref<U>> iPrefFun) Constructor custom IdxPref to IdPref converters that does not read any input data.
	RatingCODECPreferenceData(Stream<Tuple2io<int[][]>> ul, Stream<Tuple2io<int[][]>> il, FastUserIndex<U> users, FastItemIndex<I> items, CODEC<Cu> u_codec, CODEC<Ci> i_codec, CODEC<Cv> r_codec) Constructor using streams of user and items preferences lists with default IdxPref to IdPref converters.
	RatingCODECPreferenceData(Stream<Tuple2io<int[][]>> ul, Stream<Tuple2io<int[][]>> il, FastUserIndex<U> users, FastItemIndex<I> items, CODEC<Cu> u_codec, CODEC<Ci> i_codec, CODEC<Cv> r_codec, Function<IdxPref,IdPref<I>> uPrefFun, Function<IdxPref,IdPref<U>> iPrefFun) Constructor using streams of user and items preferences lists with custom IdxPref to IdPref converters.

Method Summary

Modifier and Type	Method and Description
it.unimi.dsi.fastutil.doubles.DoubleIterator	getIidxVs(int iidx) Returns the user values of the preferences for an item.
it.unimi.dsi.fastutil.doubles.DoubleIterator	getUidxVs(int uidx) Returns the item values of the preferences of a user.

Methods inherited from class org.ranksys.compression.preferences.AbstractCODECPreferenceData

getIidxUidxs, getIidxWithPreferences, getUidxIidxs, getUidxWithPreferences, numItems, numPreferences, numUsers

Methods inherited from class org.ranksys.fast.preference.IteratorsAbstractFastPreferenceData

getIidxPreferences, getPreferences, getUidxPreferences, useIteratorsPreferentially

Methods inherited from class es.uam.eps.ir.ranksys.fast.preference.AbstractFastPreferenceData

containsItem, containsUser, getAllItems, getAllUsers, getItemPreferences, getItemsWithPreferences, getUserPreferences, getUsersWithPreferences, iidx2item, item2iidx, numItems, numItems, numItemsWithPreferences, numUsers, numUsers, numUsersWithPreferences, uidx2user, user2uidx

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.preference.FastPreferenceData

getIidxPreferences, getUidxPreferences, useIteratorsPreferentially

Methods inherited from interface es.uam.eps.ir.ranksys.core.preference.PreferenceData

getItemPreferences, getItemsWithPreferences, getUserPreferences, getUsersWithPreferences, numItems, numItemsWithPreferences, numUsers, numUsersWithPreferences

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

containsUser, getAllUidx, getAllUsers, uidx2user, uidx2user, uidx2user, user2uidx, user2uidx, user2uidx

Methods inherited from interface es.uam.eps.ir.ranksys.core.index.UserIndex

numUsers

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

containsItem, getAllIidx, getAllItems, iidx2item, iidx2item, iidx2item, item2iidx, item2iidx, item2iidx

Methods inherited from interface es.uam.eps.ir.ranksys.core.index.ItemIndex

numItems

Field Detail

r_codec

protected final CODEC<Cv> r_codec

CODEC for ratings.

u_vs

protected final Cv[] u_vs

list of ratings for users.

i_vs

protected final Cv[] i_vs

list ratings for items.

Constructor Detail

RatingCODECPreferenceData

public RatingCODECPreferenceData(FastPreferenceData<U,I> preferences,
                                 FastUserIndex<U> users,
                                 FastItemIndex<I> items,
                                 CODEC<Cu> u_codec,
                                 CODEC<Ci> i_codec,
                                 CODEC<Cv> r_codec)

Constructor that utilizes other PreferenceData object with default IdxPref to IdPref converters.

Parameters:

preferences - input preference data to be copied

users - user index

items - item index

u_codec - user preferences list CODEC

i_codec - item preferences list CODEC

r_codec - ratings CODEC

RatingCODECPreferenceData

public RatingCODECPreferenceData(FastPreferenceData<U,I> preferences,
                                 FastUserIndex<U> users,
                                 FastItemIndex<I> items,
                                 CODEC<Cu> u_codec,
                                 CODEC<Ci> i_codec,
                                 CODEC<Cv> r_codec,
                                 Function<IdxPref,IdPref<I>> uPrefFun,
                                 Function<IdxPref,IdPref<U>> iPrefFun)

Constructor that utilizes other PreferenceData object with custom IdxPref to IdPref converters.

Parameters:

preferences - input preference data to be copied

users - user index

items - item index

u_codec - user preferences list CODEC

i_codec - item preferences list CODEC

r_codec - ratings CODEC

uPrefFun - user IdxPref to IdPref converter

iPrefFun - item IdxPref to IdPref converter

RatingCODECPreferenceData

public RatingCODECPreferenceData(Stream<Tuple2io<int[][]>> ul,
                                 Stream<Tuple2io<int[][]>> il,
                                 FastUserIndex<U> users,
                                 FastItemIndex<I> items,
                                 CODEC<Cu> u_codec,
                                 CODEC<Ci> i_codec,
                                 CODEC<Cv> r_codec)

Constructor using streams of user and items preferences lists with default IdxPref to IdPref converters.

Parameters:

ul - stream of user preferences lists (id-rating)

il - stream of item preferences lists (id-rating)

users - user index

items - item index

u_codec - user preferences list CODEC

i_codec - item preferences list CODEC

r_codec - ratings CODEC

RatingCODECPreferenceData

public RatingCODECPreferenceData(Stream<Tuple2io<int[][]>> ul,
                                 Stream<Tuple2io<int[][]>> il,
                                 FastUserIndex<U> users,
                                 FastItemIndex<I> items,
                                 CODEC<Cu> u_codec,
                                 CODEC<Ci> i_codec,
                                 CODEC<Cv> r_codec,
                                 Function<IdxPref,IdPref<I>> uPrefFun,
                                 Function<IdxPref,IdPref<U>> iPrefFun)

Constructor using streams of user and items preferences lists with custom IdxPref to IdPref converters.

Parameters:

ul - stream of user preferences lists (id-rating)

il - stream of item preferences lists (id-rating)

users - user index

items - item index

u_codec - user preferences list CODEC

i_codec - item preferences list CODEC

r_codec - ratings CODEC

uPrefFun - user IdxPref to IdPref converter

iPrefFun - item IdxPref to IdPref converter

RatingCODECPreferenceData

protected RatingCODECPreferenceData(FastUserIndex<U> users,
                                    FastItemIndex<I> items,
                                    CODEC<Cu> u_codec,
                                    CODEC<Ci> i_codec,
                                    CODEC<Cv> r_codec,
                                    Function<IdxPref,IdPref<I>> uPrefFun,
                                    Function<IdxPref,IdPref<U>> iPrefFun)

Constructor custom IdxPref to IdPref converters that does not read any input data.

Parameters:

users - user index

items - item index

u_codec - user preferences list CODEC

i_codec - item preferences list CODEC

r_codec - ratings CODEC

uPrefFun - user IdxPref to IdPref converter

iPrefFun - item IdxPref to IdPref converter

Method Detail

getUidxVs

public it.unimi.dsi.fastutil.doubles.DoubleIterator getUidxVs(int uidx)

Description copied from interface: FastPreferenceData

Returns the item values of the preferences of a user.

Parameters:

uidx - user index

Returns:

iterator of the values of the items

getIidxVs

public it.unimi.dsi.fastutil.doubles.DoubleIterator getIidxVs(int iidx)

Description copied from interface: FastPreferenceData

Returns the user values of the preferences for an item.

Parameters:

iidx - item index

Returns:

iterator of the values of the users