it.uniroma2.sag.kelp.utils.evaluation

Class Evaluator

java.lang.Object

it.uniroma2.sag.kelp.utils.evaluation.Evaluator

Direct Known Subclasses:

BinaryClassificationEvaluator, MulticlassClassificationEvaluator, RegressorEvaluator

public abstract class Evaluator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	computed

Constructor Summary

Constructors

Constructor and Description
Evaluator()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addCount(Example test, Prediction predicted) This method should be implemented in the subclasses to update counters useful to compute the performance measure
abstract void	clear() This method should reset the state of the evaluator
protected abstract void	compute() This method is intented to force the computation of the performance measure.
abstract Evaluator	duplicate() Returns a new instance of this Evaluator
float	getPerformanceMeasure(String performanceMeasureMethodName, Object... args) This method allow to retrieve a performance measure by specifying the name of the method to be used.

Methods inherited from class java.lang.Object

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

Field Detail

computed

protected boolean computed

Constructor Detail

Evaluator

public Evaluator()

Method Detail

getPerformanceMeasure

public float getPerformanceMeasure(String performanceMeasureMethodName,
                          Object... args)
                            throws NoSuchPerformanceMeasureException

This method allow to retrieve a performance measure by specifying the name of the method to be used.

Parameters:

performanceMeasureMethodName - the method of the name to be used to retrive the performance measure

args - the arguments to be passed to the method @param performanceMeasureMethodName.

Returns:

the float representing the requested measure

Throws:

NoSuchPerformanceMeasureException

addCount

public abstract void addCount(Example test,
            Prediction predicted)

This method should be implemented in the subclasses to update counters useful to compute the performance measure

Parameters:

test - the test example

predicted - the prediction of the system

compute

protected abstract void compute()

This method is intented to force the computation of the performance measure.

clear

public abstract void clear()

This method should reset the state of the evaluator

duplicate

public abstract Evaluator duplicate()

Returns a new instance of this Evaluator

Returns:

a new instance of this Evaluator