mulan.evaluation.measure
Class LabelBasedRecall

java.lang.Object
  extended by mulan.evaluation.measure.MeasureBase
      extended by mulan.evaluation.measure.BipartitionMeasureBase
          extended by mulan.evaluation.measure.LabelBasedBipartitionMeasureBase
              extended by mulan.evaluation.measure.LabelBasedRecall
All Implemented Interfaces:
Serializable, Measure
Direct Known Subclasses:
MacroRecall, MicroRecall

public abstract class LabelBasedRecall
extends LabelBasedBipartitionMeasureBase

Common class for the micro/macro label-based recall measures.

Version:
2012.05.29
Author:
Grigorios Tsoumakas
See Also:
Serialized Form

Field Summary
 
Fields inherited from class mulan.evaluation.measure.LabelBasedBipartitionMeasureBase
falseNegatives, falsePositives, numOfLabels, trueNegatives, truePositives
 
Constructor Summary
LabelBasedRecall(int numOfLabels)
          Constructs a new object with given number of labels
 
Method Summary
 double getIdealValue()
          Gets an 'ideal' value of a measure.
 
Methods inherited from class mulan.evaluation.measure.LabelBasedBipartitionMeasureBase
reset, updateBipartition
 
Methods inherited from class mulan.evaluation.measure.BipartitionMeasureBase
updateInternal
 
Methods inherited from class mulan.evaluation.measure.MeasureBase
makeCopy, toString, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface mulan.evaluation.measure.Measure
getName, getValue
 

Constructor Detail

LabelBasedRecall

public LabelBasedRecall(int numOfLabels)
Constructs a new object with given number of labels

Parameters:
numOfLabels - the number of labels
Method Detail

getIdealValue

public double getIdealValue()
Description copied from interface: Measure
Gets an 'ideal' value of a measure. The 'ideal' means, that the value represents the best achievable performance of a learner for an prediction of a multi-label task and associated true labels.

Returns:
the ideal value