es.uam.eps.ir.ranksys.metrics.basic

Class NDCG.NDCGRelevanceModel.UserNDCGRelevanceModel

java.lang.Object

es.uam.eps.ir.ranksys.metrics.basic.NDCG.NDCGRelevanceModel.UserNDCGRelevanceModel

All Implemented Interfaces:

UserModel.Model<U>, IdealRelevanceModel.UserIdealRelevanceModel<U,I>, RelevanceModel.UserRelevanceModel<U,I>

Enclosing class:

NDCG.NDCGRelevanceModel<U,I>

public class NDCG.NDCGRelevanceModel.UserNDCGRelevanceModel
extends Object
implements IdealRelevanceModel.UserIdealRelevanceModel<U,I>

User relevance model for nDCG.

Constructor Summary

Constructors

Constructor and Description
UserNDCGRelevanceModel(U user) Constructor.

Method Summary

Modifier and Type	Method and Description
double	gain(I item) Gain obtained by recommending the item.
double[]	getGainValues() Get the vector of gains of the relevant items.
Set<I>	getRelevantItems() Obtains all the items relevant to the user.
boolean	isRelevant(I item) Determines whether an item is relevant to the user or not

Methods inherited from class java.lang.Object

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

Constructor Detail

UserNDCGRelevanceModel

public UserNDCGRelevanceModel(U user)

Constructor.

Parameters:

user - user whose relevance model is computed

Method Detail

getRelevantItems

public Set<I> getRelevantItems()

Obtains all the items relevant to the user.

Specified by:

getRelevantItems in interface IdealRelevanceModel.UserIdealRelevanceModel<U,I>

Returns:

set of relevant items

isRelevant

public boolean isRelevant(I item)

Determines whether an item is relevant to the user or not

Specified by:

isRelevant in interface RelevanceModel.UserRelevanceModel<U,I>

Parameters:

item - input item

Returns:

true is item is relevant, false otherwise

gain

public double gain(I item)

Gain obtained by recommending the item. Should be typically positive if the item is relevant, and 0 otherwise.

Specified by:

gain in interface RelevanceModel.UserRelevanceModel<U,I>

Parameters:

item - input item

Returns:

relevance gain of the input item

getGainValues

public double[] getGainValues()

Get the vector of gains of the relevant items.

Returns:

array of positive relevance gains