EvalMetric (ProCAKE Framework 4.0.0 API)

All Known Implementing Classes:

CompletenessMetric, CorrectnessMetric, DistanceMetric, ErrorSpanMetric, HitsMetric, HitsNormMetric, KendallMetric, KEvalMetric, MAEMetric, MedianAverageErrorMetric, MSEMetric, QualityMuellerMetric, QualityStromerMetric, SpearmanMetric
```
public interface EvalMetric
```
Interface for representing ranking metrics.

Author:

Maximilian Hoffmann

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`double`	`computeEvalMetric(SimpleSimilarityResult groundTruthRankingResult, SimpleSimilarityResult predictedRankingResult)`	Computes a ranking metric for the complete ranking.
`default String`	`getMetricName()`	Returns a name for the metric to be identified in any string representations.

- Method Detail
  - getMetricName
```
default String getMetricName()
```
    Returns a name for the metric to be identified in any string representations.
    
    Returns:
    
    the name of the metric
  - computeEvalMetric
```
double computeEvalMetric(SimpleSimilarityResult groundTruthRankingResult,
                         SimpleSimilarityResult predictedRankingResult)
```
    Computes a ranking metric for the complete ranking.
    
    Parameters:
    
    groundTruthRankingResult - the ground-truth ranking
    
    predictedRankingResult - the predicted ranking (to analyze)
    
    Returns:
    
    a double score