com.rapidminer.operator.performance
Class RelativeError

java.lang.Object
  com.rapidminer.operator.AbstractIOObject
      com.rapidminer.operator.ResultObjectAdapter
          com.rapidminer.tools.math.Averagable
              com.rapidminer.operator.performance.PerformanceCriterion
                  com.rapidminer.operator.performance.MeasuredPerformance
                      com.rapidminer.operator.performance.SimpleCriterion
                          com.rapidminer.operator.performance.RelativeError

All Implemented Interfaces:

IOObject, ResultObject, Saveable, Readable, Reportable, LoggingHandler, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<PerformanceCriterion>

public class RelativeError
extends SimpleCriterion

The average relative error: Sum(|label-predicted|/label)/#examples. The relative error of label 0 and prediction 0 is defined as 0, the relative error of label 0 and prediction != 0 is infinite.

Author:

Stefan Rueping, Ingo Mierswa

See Also:

Serialized Form

Constructor Summary

RelativeError()

RelativeError(RelativeError sc)

Method Summary

double	countExample(double label, double predictedLabel) Subclasses must count the example and return the value to sum up.
boolean	formatPercent() Indicates wether or not percentage format should be used in the Averagable.toString() method.
java.lang.String	getDescription() Returns a description of the performance criterion.
java.lang.String	getName() Returns the name of this averagable.

Methods inherited from class com.rapidminer.operator.performance.SimpleCriterion

buildSingleAverage, countExample, countExampleWithWeight, getExampleCount, getFitness, getMaxFitness, getMikroAverage, getMikroVariance, startCounting, transform

Methods inherited from class com.rapidminer.operator.performance.MeasuredPerformance

startCounting

Methods inherited from class com.rapidminer.operator.performance.PerformanceCriterion

compareTo

Methods inherited from class com.rapidminer.tools.math.Averagable

buildAverage, clone, cloneAveragable, getAverage, getAverageCount, getExtension, getFileDescription, getMakroAverage, getMakroStandardDeviation, getMakroVariance, getMikroStandardDeviation, getStandardDeviation, getVariance, getVisualizationComponent, setAverageCount, toString

Methods inherited from class com.rapidminer.operator.ResultObjectAdapter

addAction, getActions, getResultIcon, isSavable, log, logError, logNote, logWarning, save, toHTML, toResultString

Methods inherited from class com.rapidminer.operator.AbstractIOObject

copy, getLog, getSource, initWriting, read, setLoggingHandler, setSource, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rapidminer.operator.IOObject

copy, getLog, getSource, setLoggingHandler, setSource, write

Constructor Detail

RelativeError

public RelativeError()

RelativeError

public RelativeError(RelativeError sc)

Method Detail

countExample

public double countExample(double label,
                           double predictedLabel)

Description copied from class: SimpleCriterion

Subclasses must count the example and return the value to sum up.

Specified by:

countExample in class SimpleCriterion

formatPercent

public boolean formatPercent()

Indicates wether or not percentage format should be used in the Averagable.toString() method. The default implementation returns false.

Overrides:

formatPercent in class Averagable

getName

public java.lang.String getName()

Description copied from class: Averagable

Returns the name of this averagable. The returned string should only contain lowercase letters and underscore (RapidMiner parameter format) since the names will be automatically used for GUI purposes.

Specified by:

getName in interface ResultObject

Specified by:

getName in class Averagable

getDescription

public java.lang.String getDescription()

Description copied from class: PerformanceCriterion

Returns a description of the performance criterion. This description is used for GUI purposes and automatic parameter type creation for the PerformanceEvaluator operator.

Specified by:

getDescription in class PerformanceCriterion