edu.uci.jforests.eval.ranking

Class NDCGEval

java.lang.Object

edu.uci.jforests.eval.EvaluationMetric

edu.uci.jforests.eval.ranking.RankingEvaluationMetric

edu.uci.jforests.eval.ranking.NDCGEval

public class NDCGEval
extends RankingEvaluationMetric

Nested Class Summary

Nested classes/interfaces inherited from class edu.uci.jforests.eval.ranking.RankingEvaluationMetric

RankingEvaluationMetric.SwapScorer

Field Summary

Fields

Modifier and Type	Field and Description
static double[]	discounts
static int	GAIN_LEVELS
static double[]	GAINS
static int	MAX_TRUNCATION_LEVEL

Constructor Summary

Constructors

Constructor and Description
NDCGEval(int maxDocsPerQuery, int evalTruncationLevel)

Method Summary

Modifier and Type	Method and Description
static int[][]	getLabelCountsForQueries(double[] labels, int[] boundaries)
static double[]	getMaxDCGForAllQueriesAtTruncation(double[] labels, int[] boundaries, int trunc, int[][] labelCounts)
static double[][]	getMaxDCGForAllQueriesUptoTruncation(double[] labels, int[] boundaries, int trunc, int[][] labelCounts)
double[]	getNDCGatAllTruncations(double[] predictions, Sample sample, ScoreBasedComparator.TieBreaker tieBreaker)
double[][]	getNDCGatAllTruncationsAllQueries(double[] predictions, Sample sample, ScoreBasedComparator.TieBreaker tieBreaker)
RankingEvaluationMetric.SwapScorer	getSwapScorer(double[] targets, int[] boundaries, int trunc, int[][] labelCounts)
static void	initialize(int maxDocsPerQuery)
double	measure(double[] predictions, Sample sample)
double[]	measureByQuery(double[] predictions, Sample sample)

Methods inherited from class edu.uci.jforests.eval.ranking.RankingEvaluationMetric

computeNaturalOrderScores, getParentMetric

Methods inherited from class edu.uci.jforests.eval.EvaluationMetric

isFirstBetter, largerIsBetter

Methods inherited from class java.lang.Object

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

Field Detail

MAX_TRUNCATION_LEVEL

public static final int MAX_TRUNCATION_LEVEL

See Also:

Constant Field Values

GAIN_LEVELS

public static final int GAIN_LEVELS

See Also:

Constant Field Values

GAINS

public static double[] GAINS

discounts

public static double[] discounts

Constructor Detail

NDCGEval

public NDCGEval(int maxDocsPerQuery,
                int evalTruncationLevel)
         throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

initialize

public static void initialize(int maxDocsPerQuery)

getLabelCountsForQueries

public static int[][] getLabelCountsForQueries(double[] labels,
                                               int[] boundaries)

getMaxDCGForAllQueriesUptoTruncation

public static double[][] getMaxDCGForAllQueriesUptoTruncation(double[] labels,
                                                              int[] boundaries,
                                                              int trunc,
                                                              int[][] labelCounts)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

getMaxDCGForAllQueriesAtTruncation

public static double[] getMaxDCGForAllQueriesAtTruncation(double[] labels,
                                                          int[] boundaries,
                                                          int trunc,
                                                          int[][] labelCounts)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getNDCGatAllTruncations

public double[] getNDCGatAllTruncations(double[] predictions,
                                        Sample sample,
                                        ScoreBasedComparator.TieBreaker tieBreaker)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getNDCGatAllTruncationsAllQueries

public double[][] getNDCGatAllTruncationsAllQueries(double[] predictions,
                                                    Sample sample,
                                                    ScoreBasedComparator.TieBreaker tieBreaker)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

measure

public double measure(double[] predictions,
                      Sample sample)
               throws java.lang.Exception

Overrides:

measure in class RankingEvaluationMetric

Throws:

java.lang.Exception

measureByQuery

public double[] measureByQuery(double[] predictions,
                               Sample sample)
                        throws java.lang.Exception

Specified by:

measureByQuery in class RankingEvaluationMetric

Throws:

java.lang.Exception

getSwapScorer

public RankingEvaluationMetric.SwapScorer getSwapScorer(double[] targets,
                                                        int[] boundaries,
                                                        int trunc,
                                                        int[][] labelCounts)
                                                 throws java.lang.Exception

Specified by:

getSwapScorer in class RankingEvaluationMetric

Parameters:

targets - Targets of all documents in dataset. Equals Dataset.*.length

boundaries - Start and end indices of each query within the dataset.

trunc - Truncation level for evaluation measure

labelCounts - How many of each label value

Throws:

java.lang.Exception - if things go pear shaped