es.uam.eps.ir.ranksys.metrics.rel

Class IdealRelevanceModel<U,I>

java.lang.Object

es.uam.eps.ir.ranksys.core.model.UserModel<U>

es.uam.eps.ir.ranksys.metrics.rel.RelevanceModel<U,I>

es.uam.eps.ir.ranksys.metrics.rel.IdealRelevanceModel<U,I>

Type Parameters:

U - type of the users

I - type of the items

Direct Known Subclasses:

BinaryRelevanceModel, NDCG.NDCGRelevanceModel

public abstract class IdealRelevanceModel<U,I>
extends RelevanceModel<U,I>

Relevance model in which there is full, a-priori knowledge of the relevance of all the items in the collection.

Author:

Saúl Vargas (saul.vargas@uam.es), Pablo Castells (pablo.castells@uam.es)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IdealRelevanceModel.UserIdealRelevanceModel<U,I> User relevance model for IdealRelevanceModel

Nested classes/interfaces inherited from class es.uam.eps.ir.ranksys.metrics.rel.RelevanceModel

RelevanceModel.UserRelevanceModel<U,I>

Nested classes/interfaces inherited from class es.uam.eps.ir.ranksys.core.model.UserModel

UserModel.Model<U>

Constructor Summary

Constructors

Constructor and Description
IdealRelevanceModel() No caching constructor.
IdealRelevanceModel(boolean caching, Stream<U> users) Full constructor: allows to specify whether to cache the user relevance models and for which users.
IdealRelevanceModel(Stream<U> users) Caching constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract IdealRelevanceModel.UserIdealRelevanceModel<U,I>	get(U user) Calculates the user model for user u.
IdealRelevanceModel.UserIdealRelevanceModel<U,I>	getModel(U user) Returns the user model for user u.

Methods inherited from class es.uam.eps.ir.ranksys.core.model.UserModel

initialize

Methods inherited from class java.lang.Object

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

Constructor Detail

IdealRelevanceModel

public IdealRelevanceModel(boolean caching,
                           Stream<U> users)

Full constructor: allows to specify whether to cache the user relevance models and for which users.

Parameters:

caching - are the user relevance models cached?

users - users whose relevance models are cached

IdealRelevanceModel

public IdealRelevanceModel()

No caching constructor.

IdealRelevanceModel

public IdealRelevanceModel(Stream<U> users)

Caching constructor.

Parameters:

users - users whose relevance models are cached

Method Detail

get

protected abstract IdealRelevanceModel.UserIdealRelevanceModel<U,I> get(U user)

Description copied from class: UserModel

Calculates the user model for user u.

Specified by:

get in class RelevanceModel<U,I>

Parameters:

user - the user

Returns:

a user model

getModel

public IdealRelevanceModel.UserIdealRelevanceModel<U,I> getModel(U user)

Description copied from class: UserModel

Returns the user model for user u.

Overrides:

getModel in class RelevanceModel<U,I>

Parameters:

user - the user

Returns:

a user model