ireval::SetRetrievalEvaluator Class Reference

List of all members.

Public Member Functions
	SetRetrievalEvaluator (Collection< RetrievalEvaluator > evaluators)
Collection< RetrievalEvaluator >	getEvaluators ()
double[]	precisionAtFixedPoints ()
double[]	interpolatedPrecision ()
double	meanAveragePrecision ()
double	meanBinaryPreference ()
double	geometricMeanAveragePrecision ()
double	meanPrecision (int documentsRetrieved)
double	meanReciprocalRank ()
double	meanRPrecision ()
double	meanNormalizedDiscountedCumulativeGain ()
double	meanNormalizedDiscountedCumulativeGain (int documentsRetrieved)
Map< String, Double >	evaluateAll (String metric) throws IllegalArgumentException
int	numberRetrieved ()
int	numberRelevant ()
int	numberRelevantRetrieved ()
Static Public Member Functions
int[]	getFixedPoints ()
Package Attributes
Collection< RetrievalEvaluator >	_evaluators

---

Detailed Description

Computes summary statistics over a set of queries.

Author:

Trevor Strohman

---

Constructor & Destructor Documentation

ireval::SetRetrievalEvaluator::SetRetrievalEvaluator (  Collection< RetrievalEvaluator >  evaluators  )  [inline]

Creates a new instance of SetRetrievalEvaluator

---

Member Function Documentation

Map<String, Double> ireval::SetRetrievalEvaluator::evaluateAll (  String  metric  )  throws IllegalArgumentException [inline]

Returns a Map containing a particular metric value for each query. For instance, if metric == "averagePrecision", this returns a map where the keys are query identifiers and the values are the average precision metric evaluated for each query.

double ireval::SetRetrievalEvaluator::geometricMeanAveragePrecision (   )  [inline]

Returns the geometric mean of average precision values for all queries.

Collection<RetrievalEvaluator> ireval::SetRetrievalEvaluator::getEvaluators (   )  [inline]

Returns a collection of evaluators.

int [] ireval::SetRetrievalEvaluator::getFixedPoints (   )  [inline, static]

double [] ireval::SetRetrievalEvaluator::interpolatedPrecision (   )  [inline]

double ireval::SetRetrievalEvaluator::meanAveragePrecision (   )  [inline]

Returns the mean average precision; the mean of the average precision values for all queries.

double ireval::SetRetrievalEvaluator::meanBinaryPreference (   )  [inline]

Returns the mean of the binary preference values for all queries.

double ireval::SetRetrievalEvaluator::meanNormalizedDiscountedCumulativeGain (  int  documentsRetrieved  )  [inline]

Returns the mean of the NDCG values for all queries.

double ireval::SetRetrievalEvaluator::meanNormalizedDiscountedCumulativeGain (   )  [inline]

Returns the mean of the NDCG values for all queries.

double ireval::SetRetrievalEvaluator::meanPrecision (  int  documentsRetrieved  )  [inline]

Returns the mean of the precision values for all queries.

double ireval::SetRetrievalEvaluator::meanReciprocalRank (   )  [inline]

Returns the mean of the reciprocal rank values for all queries.

double ireval::SetRetrievalEvaluator::meanRPrecision (   )  [inline]

Returns the mean of the R-precision values for all queries.

int ireval::SetRetrievalEvaluator::numberRelevant (   )  [inline]

The total number of relevant documents to any of the queries.

int ireval::SetRetrievalEvaluator::numberRelevantRetrieved (   )  [inline]

The total number of relevant documents retrieved for any of the queries.

int ireval::SetRetrievalEvaluator::numberRetrieved (   )  [inline]

The number of documents retrieved for all queries.

double [] ireval::SetRetrievalEvaluator::precisionAtFixedPoints (   )  [inline]

---

Member Data Documentation

Collection<RetrievalEvaluator> ireval::SetRetrievalEvaluator::_evaluators [package]

---

The documentation for this class was generated from the following file:

• SetRetrievalEvaluator.java

---