Evaluator (adams-spectral-base-pom 25.11.0-SNAPSHOT API)

All Superinterfaces:

adams.core.CleanUpHandler, Comparable, adams.core.Destroyable, adams.core.option.OptionHandler, Serializable, adams.core.ShallowCopySupporter<Evaluator>

All Known Subinterfaces:

WekaClassifierBasedEvaluator

All Known Implementing Classes:

AbstractEvaluator, AbstractNearestNeighborBasedEvaluator, AbstractSerializableEvaluator, CrossValidatedNeighborHood, CrossValidatedPrediction, DistanceToCenter, DistanceToClosest, EnsembleEvaluator, FakeEvaluator, IntervalEstimatorEvaluator, MultiClassifierEvaluator, NullEvaluator, SavitzkyGolayRange
```
public interface Evaluator
extends adams.core.option.OptionHandler, Serializable, Comparable, adams.core.CleanUpHandler, adams.core.ShallowCopySupporter<Evaluator>
```
Interface for evaluators.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`build(weka.core.Instances data)`	Performs the check.
`HashMap<String,Float>`	`evaluate(weka.core.Instance data)`	Performs the check.
`float`	`getMissingEvaluation()`	Returns the replacement string for missing evaluations.
`String`	`missingEvaluationTipText()`	Returns the tip text for this property.
`void`	`setMissingEvaluation(float value)`	Sets the replacement string for missing evaluations.

Methods inherited from interface adams.core.CleanUpHandler
cleanUp

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.ShallowCopySupporter
shallowCopy, shallowCopy

- Method Detail
  - setMissingEvaluation
```
void setMissingEvaluation(float value)
```
    Sets the replacement string for missing evaluations.
    
    Parameters:
    
    value - the replacement
  - getMissingEvaluation
```
float getMissingEvaluation()
```
    Returns the replacement string for missing evaluations.
    
    Returns:
    
    the replacement
  - missingEvaluationTipText
```
String missingEvaluationTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - build
```
boolean build(weka.core.Instances data)
```
    Performs the check.
    
    Parameters:
    
    data - the instances to check
    
    Returns:
    
    evaluation metric
  - evaluate
```
HashMap<String,Float> evaluate(weka.core.Instance data)
```
    Performs the check.
    
    Parameters:
    
    data - the instance to check
    
    Returns:
    
    evaluation metrics, getMissingEvaluation() in case the class value is missing