ErrorSpanMetric (ProCAKE Framework 4.0.0 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`computeEvalMetric(SimpleSimilarityResult groundTruthRankingResult, SimpleSimilarityResult predictedRankingResult)`	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 Detail
  - ErrorSpanMetric
```
public ErrorSpanMetric()
```
- Method Detail
  - computeEvalMetric
```
public double computeEvalMetric(SimpleSimilarityResult groundTruthRankingResult,
                                SimpleSimilarityResult predictedRankingResult)
```
    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:
    
    groundTruthRankingResult - ground-truth results
    
    predictedRankingResult - 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