edu.columbia.cs.ref.algorithm.evaluation.measure.impl
Class FMeasure

java.lang.Object
  edu.columbia.cs.ref.algorithm.evaluation.measure.impl.FMeasure

All Implemented Interfaces:

Measure

public class FMeasure
extends java.lang.Object
implements Measure

The Class FMeasure represents the F-Measure. The f-measure corresponds to a weighted harmonic mean between recall and precision. The weight is controled by a parameter β.

The equation for the F-Measure with parameter β is:

Since:

2011-09-27

Version:

0.1

Author:

Pablo Barrio, Goncalo Simoes

Constructor Summary

FMeasure(double beta)
Instantiates a new f measure with a given parameter β

Method Summary

double

getValue(java.util.Map<OperableStructure,java.util.Set<java.lang.String>> labels, java.util.Map<OperableStructure,java.util.Map<Model.PredictionProperties,java.lang.Object>> properties) Obtains the value of the metric

Methods inherited from class java.lang.Object

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

Constructor Detail

FMeasure

public FMeasure(double beta)

Instantiates a new f measure with a given parameter β

Parameters:

beta - the β parameter

Method Detail

getValue

public double getValue(java.util.Map<OperableStructure,java.util.Set<java.lang.String>> labels,
                       java.util.Map<OperableStructure,java.util.Map<Model.PredictionProperties,java.lang.Object>> properties)

Description copied from interface: Measure

Obtains the value of the metric

Specified by:

getValue in interface Measure

Parameters:

labels - map that associates a label to each operable structure

properties - map that stores the properties of the prediction

Returns:

the value of the metric