Evaluation (Terrier Information Retrieval Platform 5.5 API)

All Known Implementing Classes:

AdhocEvaluation, AdhocFullQueryEvaluation, NamedPageEvaluation, TerrierEvaluation, TrecEvalEvaluation
```
public interface Evaluation
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`evaluate(java.lang.String resultFilename)`	Evaluates the given result file for the given qrels file.
`void`	`writeEvaluationResult()`	Output the evaluation result to standard output
`void`	`writeEvaluationResult(java.io.PrintWriter out)`	The abstract method that evaluates and prints the results.
`void`	`writeEvaluationResult(java.lang.String resultEvalFilename)`	Output the evaluation result to the specific file.
`void`	`writeEvaluationResultOfEachQuery(java.lang.String evaluationResultFilename)`	Output the evaluation result of each query to the specific file.

- Method Detail
  - evaluate
```
void evaluate(java.lang.String resultFilename)
```
    Evaluates the given result file for the given qrels file. All subclasses must implement this method.
    
    Parameters:
    
    resultFilename - java.lang.String the filename of the result file to evaluate.
  - writeEvaluationResult
```
void writeEvaluationResult()
```
    Output the evaluation result to standard output
  - writeEvaluationResult
```
void writeEvaluationResult(java.io.PrintWriter out)
```
    The abstract method that evaluates and prints the results. All the subclasses of Evaluation must implement this method.
    
    Parameters:
    
    out - java.io.PrintWriter
  - writeEvaluationResultOfEachQuery
```
void writeEvaluationResultOfEachQuery(java.lang.String evaluationResultFilename)
```
    Output the evaluation result of each query to the specific file.
    
    Parameters:
    
    evaluationResultFilename - String the name of the file in which to save the evaluation results.
  - writeEvaluationResult
```
void writeEvaluationResult(java.lang.String resultEvalFilename)
```
    Output the evaluation result to the specific file.
    
    Parameters:
    
    resultEvalFilename - java.lang.String the filename of the file to output the result.