Package adams.data.statistics

Class ArrayRSquared<T extends Number>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.statistics.AbstractArrayStatistic<T>

adams.data.statistics.ArrayRSquared<T>

Type Parameters:

T - the data to process

All Implemented Interfaces:

AdditionalInformationHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractArrayStatistic>, SizeOfHandler, EqualLengthArrayStatistic, Serializable

public class ArrayRSquared<T extends Number>
extends AbstractArrayStatistic<T>
implements EqualLengthArrayStatistic

Calculates the R^2 between the first array and the remaining arrays. The arrays must be numeric, of course.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.statistics.AbstractArrayStatistic

AbstractArrayStatistic.StatisticContainer<T extends Serializable>

Field Summary

Fields inherited from class adams.data.statistics.AbstractArrayStatistic

m_Data

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ArrayRSquared()

Method Summary

Modifier and Type	Method	Description
protected AbstractArrayStatistic.StatisticContainer	doCalculate()	Generates the actual result.
int	getLength()	Returns the length of the stored arrays.
int	getMax()	Returns the maximum number of arrays that need to be present.
int	getMin()	Returns the minimum number of arrays that need to be present.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.data.statistics.AbstractArrayStatistic

add, calculate, check, checkEqualLength, clear, forCommandLine, forName, get, getAdditionalInformation, getStatistics, initialize, remove, set, shallowCopy, shallowCopy, size, toString

Methods inherited from class adams.core.option.AbstractOptionHandler

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

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

Constructor Detail

ArrayRSquared

public ArrayRSquared()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getMin

public int getMin()

Returns the minimum number of arrays that need to be present. -1 for unbounded.

Specified by:

getMin in class AbstractArrayStatistic<T extends Number>

Returns:

the minimum number, -1 for unbounded

getMax

public int getMax()

Returns the maximum number of arrays that need to be present. -1 for unbounded.

Specified by:

getMax in class AbstractArrayStatistic<T extends Number>

Returns:

the maximum number, -1 for unbounded

getLength

public int getLength()

Returns the length of the stored arrays.

Specified by:

getLength in interface EqualLengthArrayStatistic

Returns:

the length of the arrays, -1 if none stored

doCalculate

protected AbstractArrayStatistic.StatisticContainer doCalculate()

Generates the actual result.

Specified by:

doCalculate in class AbstractArrayStatistic<T extends Number>

Returns:

the generated result