jsat.regression.evaluation

Interface RegressionScore

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoefficientOfDetermination, MeanAbsoluteError, MeanSquaredError, RelativeAbsoluteError, RelativeSquaredError, TotalHistoryRegressionScore

public interface RegressionScore
extends Serializable

This interface defines the contract for evaluating or "scoring" the results on a regression problem.

All regression scores must override the equals(java.lang.Object) and hashCode() methods. If a score has parameters, different objects with different parameters must not be equal. However, different objects with the same parameters must be equal even if their internal states are different

Author:

Edward Raff

Method Summary

Modifier and Type	Method and Description
void	addResult(double prediction, double trueValue, double weight) Adds the given result to the score
void	addResults(RegressionScore other) The score contained in this object is augmented with the results already accumulated in the other object.
RegressionScore	clone()
boolean	equals(Object obj)
String	getName() Returns the name to present for this score
double	getScore() Computes the score for the results that have been enrolled via addResult(double, double, double)
int	hashCode()
boolean	lowerIsBetter() Returns true if a lower score is better, or false if a higher score is better
void	prepare()

Method Detail

prepare

void prepare()

addResult

void addResult(double prediction,
               double trueValue,
               double weight)

Adds the given result to the score

Parameters:

prediction - the prediction for the data point

trueValue - the true value for the data point

weight - the weigh to assign to the data point

addResults

void addResults(RegressionScore other)

The score contained in this object is augmented with the results already accumulated in the other object. This does not result in an averaging, but alters the current object to have the same score it would have had if all the results were originally inserted into this object.

This method is only required to work if other if of the same class as this object.

Parameters:

other - the object to add the results from

getScore

double getScore()

Computes the score for the results that have been enrolled via addResult(double, double, double)

Returns:

the score for the current results

lowerIsBetter

boolean lowerIsBetter()

Returns true if a lower score is better, or false if a higher score is better

Returns:

true if a lower score is better

equals

boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

clone

RegressionScore clone()

getName

String getName()

Returns the name to present for this score

Returns:

the score name