mulan.evaluation.measure
Class MicroRecall

java.lang.Object
  mulan.evaluation.measure.MeasureBase
      mulan.evaluation.measure.BipartitionMeasureBase
          mulan.evaluation.measure.LabelBasedBipartitionMeasureBase
              mulan.evaluation.measure.LabelBasedRecall
                  mulan.evaluation.measure.MicroRecall

All Implemented Interfaces:

Serializable, Measure

public class MicroRecall
extends LabelBasedRecall

Implementation of the micro-averaged recall measure.

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

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

Method Summary

String	getName() Gets the name of a measure.
double	getValue() Gets the value of a measure.

Methods inherited from class mulan.evaluation.measure.LabelBasedRecall

getIdealValue

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

Constructor Detail

MicroRecall

public MicroRecall(int numOfLabels)

Constructs a new object with given number of labels

Parameters:

numOfLabels - the number of labels

Method Detail

getValue

public double getValue()

Description copied from interface: Measure

Gets the value of a measure. The measure is incrementally cumulated for learner's prediction by each Measure.update(MultiLabelOutput, boolean[]) call. The value returned by the method, returns sum of all update calls divided by the number of calls (average of all measures for all predictions).

Returns:

the average measure value computed so far

getName

public String getName()

Description copied from interface: Measure

Gets the name of a measure.

Returns:

the name of a measure.