Package adams.flow.transformer.summarystatistics

Class AbstractNumericSummaryStatistic

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.summarystatistics.AbstractSummaryStatistic

adams.flow.transformer.summarystatistics.AbstractNumericSummaryStatistic

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, NumericSummaryStatistic, SummaryStatistic, Serializable

Direct Known Subclasses:

CorrelationCoefficient, MeanAbsoluteError, RootMeanSquaredError

public abstract class AbstractNumericSummaryStatistic
extends AbstractSummaryStatistic
implements NumericSummaryStatistic

Ancestor for summary statistics that work with numeric predictions.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double[]	m_NumericActual	the actual values.
protected double[]	m_NumericPredicted	the predicted values.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.transformer.summarystatistics.NumericSummaryStatistic

MISSING_NUMERIC

Constructor Summary

Constructors

Constructor	Description
AbstractNumericSummaryStatistic()

Method Summary

Modifier and Type	Method	Description
protected String	check()	Hook method for performing checks before calculating statistic.
void	clear()	Clears all input.
double[]	getNumericActual()	Returns the actual values.
double[]	getNumericPredicted()	Returns the predicted values.
void	setNumericActual(double[] value)	Sets the actual values.
void	setNumericPredicted(double[] value)	Sets the predicted values.

Methods inherited from class adams.flow.transformer.summarystatistics.AbstractSummaryStatistic

calculate, doCalculate

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.flow.transformer.summarystatistics.SummaryStatistic

calculate, getNames

Field Detail

m_NumericActual

protected double[] m_NumericActual

the actual values.

m_NumericPredicted

protected double[] m_NumericPredicted

the predicted values.

Constructor Detail

AbstractNumericSummaryStatistic

public AbstractNumericSummaryStatistic()

Method Detail

clear

public void clear()

Clears all input.

Specified by:

clear in interface SummaryStatistic

Overrides:

clear in class AbstractSummaryStatistic

setNumericActual

public void setNumericActual(double[] value)

Sets the actual values.

Specified by:

setNumericActual in interface NumericSummaryStatistic

Parameters:

value - the actual

getNumericActual

public double[] getNumericActual()

Returns the actual values.

Specified by:

getNumericActual in interface NumericSummaryStatistic

Returns:

the actual

setNumericPredicted

public void setNumericPredicted(double[] value)

Sets the predicted values.

Specified by:

setNumericPredicted in interface NumericSummaryStatistic

Parameters:

value - the predicted

getNumericPredicted

public double[] getNumericPredicted()

Returns the predicted values.

Specified by:

getNumericPredicted in interface NumericSummaryStatistic

Returns:

the predicted

check

protected String check()

Hook method for performing checks before calculating statistic.

Overrides:

check in class AbstractSummaryStatistic

Returns:

null if successful, otherwise error message