jsat.regression.evaluation

Class RelativeSquaredError

java.lang.Object

jsat.regression.evaluation.TotalHistoryRegressionScore

jsat.regression.evaluation.RelativeSquaredError

All Implemented Interfaces:

Serializable, RegressionScore

public class RelativeSquaredError
extends TotalHistoryRegressionScore

Uses the Sum of Squared Errors divided by the sum of the squared true values subtracted from their mean. This produces an error metric that has no units.

Author:

Edward Raff

See Also:

Serialized Form

Field Summary

Fields inherited from class jsat.regression.evaluation.TotalHistoryRegressionScore

predictions, truths, weights

Constructor Summary

Constructors

Constructor and Description
RelativeSquaredError() Creates a new Relative Squared Error object
RelativeSquaredError(RelativeSquaredError toCopy) Copy constructor

Method Summary

Modifier and Type	Method and Description
RelativeSquaredError	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 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

Methods inherited from class jsat.regression.evaluation.TotalHistoryRegressionScore

addResult, addResults, prepare

Methods inherited from class java.lang.Object

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

Constructor Detail

RelativeSquaredError

public RelativeSquaredError()

Creates a new Relative Squared Error object

RelativeSquaredError

public RelativeSquaredError(RelativeSquaredError toCopy)

Copy constructor

Parameters:

toCopy - the object to copy

Method Detail

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)

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

Returns:

true if a lower score is better

clone

public RelativeSquaredError clone()

Specified by:

clone in interface RegressionScore

Specified by:

clone in class TotalHistoryRegressionScore

hashCode

public int hashCode()

Specified by:

hashCode in interface RegressionScore

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface RegressionScore

Overrides:

equals in class Object

getName

public String getName()

Description copied from interface: RegressionScore

Returns the name to present for this score

Returns:

the score name