jsat.regression.evaluation

Class MeanAbsoluteError

java.lang.Object

jsat.regression.evaluation.MeanAbsoluteError

All Implemented Interfaces:

java.io.Serializable, RegressionScore

public class MeanAbsoluteError
extends java.lang.Object
implements RegressionScore

Uses the Mean of Absolute Errors between the predictions and the true values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MeanAbsoluteError()
MeanAbsoluteError(MeanAbsoluteError toCopy) Copy constructor

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.
MeanAbsoluteError	clone()
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name to present for this score
double	getScore() Computes the score for the results that have been enrolled via RegressionScore.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()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MeanAbsoluteError

public MeanAbsoluteError()

MeanAbsoluteError

public MeanAbsoluteError(MeanAbsoluteError toCopy)

Copy constructor

Parameters:

toCopy - the object to copy

Method Detail

prepare

public void prepare()

Specified by:

prepare in interface RegressionScore

addResult

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

Description copied from interface: RegressionScore

Adds the given result to the score

Specified by:

addResult in interface RegressionScore

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

public void addResults(RegressionScore other)

Description copied from interface: RegressionScore

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.

Specified by:

addResults in interface RegressionScore

Parameters:

other - the object to add the results from

getScore

public double getScore()

Description copied from interface: RegressionScore

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

Specified by:

getScore in interface RegressionScore

Returns:

the score for the current results

lowerIsBetter

public boolean lowerIsBetter()

Description copied from interface: RegressionScore

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

Specified by:

lowerIsBetter in interface RegressionScore

Returns:

true if a lower score is better

clone

public MeanAbsoluteError clone()

Specified by:

clone in interface RegressionScore

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface RegressionScore

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface RegressionScore

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Description copied from interface: RegressionScore

Returns the name to present for this score

Specified by:

getName in interface RegressionScore

Returns:

the score name