Package de.uni_trier.wi2.procake.utils.eval.metrics.full

Class ErrorSpanMetric

java.lang.Object

de.uni_trier.wi2.procake.utils.eval.metrics.full.ErrorSpanMetric

All Implemented Interfaces:

EvalMetric

public class ErrorSpanMetric
extends Object
implements EvalMetric

Author:

Maximilian Hoffmann

Constructor Summary

Constructors

Constructor	Description
ErrorSpanMetric()

Method Summary

Modifier and Type	Method	Description
double	computeEvalMetric(SimpleSimilarityResult groundTruthResult, SimpleSimilarityResult predictedResult)	Computes error span for two retrieval results.
String	getMetricName()	Returns a name for the metric to be identified in any string representations.

Methods inherited from class java.lang.Object

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

Constructor Details

ErrorSpanMetric

public ErrorSpanMetric()

Method Details

computeEvalMetric

public double computeEvalMetric(SimpleSimilarityResult groundTruthResult,
 SimpleSimilarityResult predictedResult)

Computes error span for two retrieval results. Normally, this method is used to compare the ground-truth values with the values to test.

Specified by:

computeEvalMetric in interface EvalMetric

Parameters:

groundTruthResult - ground-truth results

predictedResult - results to test

Returns:

error span

getMetricName

public String getMetricName()

Description copied from interface: EvalMetric

Returns a name for the metric to be identified in any string representations.

Specified by:

getMetricName in interface EvalMetric

Returns:

the name of the metric