es.uam.eps.ir.ranksys.fast.index

Interface FastUserIndex<U>

Type Parameters:

U - type of the users

All Superinterfaces:

UserIndex<U>

All Known Subinterfaces:

FastPointWisePreferenceData<U,I>, FastPreferenceData<U,I>, FastPreferenceSampler<U,I>, FastRecommender<U,I>

All Known Implementing Classes:

AbstractCODECPreferenceData, AbstractFastPreferenceData, AbstractFastPreferenceSampler, AbstractFastRecommender, BinaryCODECPreferenceData, CachedUserNeighborhood, Factorization, FastEnsembleRecommender, FastRankingRecommender, FMRecommender, InvertedUserNeighborhood, ItemNeighborhoodRecommender, IteratorsAbstractFastPreferenceData, LDARecommender, MFRecommender, PopularityRecommender, PreferenceFM, RandomRecommender, RatingCODECPreferenceData, RerankingRecommender, SetCosineUserSimilarity, SetJaccardUserSimilarity, SimpleFastPreferenceData, SimpleFastUserIndex, StreamsAbstractFastPreferenceData, ThresholdUserNeighborhood, TopKUserNeighborhood, TransposedPreferenceData, UserNeighborhood, UserNeighborhoodRecommender, UserSimilarity, VectorCosineUserSimilarity, VectorJaccardUserSimilarity

public interface FastUserIndex<U>
extends UserIndex<U>

Fast version of UserIndex, where users are internally represented with numerical indices from 0 (inclusive) to the number of indexed users (exclusive).

Author:

Saúl Vargas (saul.vargas@uam.es)

Method Summary

Modifier and Type	Method and Description
default boolean	containsUser(U u) Checks whether the index contains a user.
default IntStream	getAllUidx() Gets all the indices of the users.
default Stream<U>	getAllUsers() Retrieves a stream of the indexed users.
U	uidx2user(int uidx) Returns the user represented with the index.
default Tuple2od<U>	uidx2user(Tuple2id tuple) Applies FastUserIndex::uidx2user to the first element of the tuple.
default <V> org.jooq.lambda.tuple.Tuple2<U,V>	uidx2user(Tuple2io<V> tuple) Applies FastUserIndex::uidx2user to the first element of the tuple.
default <V> Tuple2io<V>	user2uidx(org.jooq.lambda.tuple.Tuple2<U,V> tuple) Applies FastUserIndex::user2uidx to the first element of the tuple.
default Tuple2id	user2uidx(Tuple2od<U> tuple) Applies FastUserIndex::user2uidx to the first element of the tuple.
int	user2uidx(U u) Returns the index assigned to the user.

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

numUsers

Method Detail

containsUser

default boolean containsUser(U u)

Description copied from interface: UserIndex

Checks whether the index contains a user.

Specified by:

containsUser in interface UserIndex<U>

Parameters:

u - user

Returns:

true if the index contains the user, false otherwise

getAllUsers

default Stream<U> getAllUsers()

Description copied from interface: UserIndex

Retrieves a stream of the indexed users.

Specified by:

getAllUsers in interface UserIndex<U>

Returns:

a stream of all the users

getAllUidx

default IntStream getAllUidx()

Gets all the indices of the users.

Returns:

a stream of indexes of users

user2uidx

int user2uidx(U u)

Returns the index assigned to the user.

Parameters:

u - user

Returns:

the index of the user, or -1 if the user does not exist

uidx2user

U uidx2user(int uidx)

Returns the user represented with the index.

Parameters:

uidx - user index

Returns:

the user whose index is uidx

user2uidx

default <V> Tuple2io<V> user2uidx(org.jooq.lambda.tuple.Tuple2<U,V> tuple)

Applies FastUserIndex::user2uidx to the first element of the tuple.

Type Parameters:

V - type of value

Parameters:

tuple - user-value tuple

Returns:

uidx-value tuple

uidx2user

default <V> org.jooq.lambda.tuple.Tuple2<U,V> uidx2user(Tuple2io<V> tuple)

Applies FastUserIndex::uidx2user to the first element of the tuple.

Type Parameters:

V - type of value

Parameters:

tuple - uidx-value tuple

Returns:

user-value tuple

user2uidx

default Tuple2id user2uidx(Tuple2od<U> tuple)

Applies FastUserIndex::user2uidx to the first element of the tuple.

Parameters:

tuple - user-double tuple

Returns:

uidx-double tuple

uidx2user

default Tuple2od<U> uidx2user(Tuple2id tuple)

Applies FastUserIndex::uidx2user to the first element of the tuple.

Parameters:

tuple - uidx-double tuple

Returns:

user-double tuple