Package adams.data.binning.algorithm

Class AbstractEqualWidthBinningAlgorithm

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.binning.algorithm.AbstractBinningAlgorithm

adams.data.binning.algorithm.AbstractEqualWidthBinningAlgorithm

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, BinningAlgorithm, Serializable

Direct Known Subclasses:

DensityBinning, FreedmanDiaconisChoiceBinning, ManualBinning, RiceRuleBinning, ScottsNormalReferenceRuleBinning, SquareRootChoiceBinning, SturgesFormulaBinning

public abstract class AbstractEqualWidthBinningAlgorithm
extends AbstractBinningAlgorithm

Ancestor for algorithms that use bins with the same width.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.binning.algorithm.AbstractBinningAlgorithm

m_NumDecimals

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
AbstractEqualWidthBinningAlgorithm()

Method Summary

Modifier and Type	Method	Description
protected <T> List<Bin<T>>	doGenerateBins(double min, double max, double binWidth)	Generates bins with the specified width.
protected <T> List<Bin<T>>	doGenerateBins(double min, double max, int numBins)	Generates equal-width bins.
protected <T> List<Bin<T>>	doGenerateBins(com.github.fracpete.javautils.struct.Struct2<Double,Double> minMax, double binWidth)	Generates bins with the specified width.
protected <T> List<Bin<T>>	doGenerateBins(com.github.fracpete.javautils.struct.Struct2<Double,Double> minMax, int numBins)	Generates equal-width bins.
protected <T> List<Bin<T>>	doGenerateBins(List<Binnable<T>> objects, double binWidth)	Generates bins with the specified width.
protected <T> List<Bin<T>>	doGenerateBins(List<Binnable<T>> objects, int numBins)	Generates equal-width bins.

Methods inherited from class adams.data.binning.algorithm.AbstractBinningAlgorithm

check, defineOptions, doGenerateBins, fillBins, generateBins, getMinMax, getNumDecimals, getQuickInfo, numDecimalsTipText, setNumDecimals

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractEqualWidthBinningAlgorithm

public AbstractEqualWidthBinningAlgorithm()

Method Detail

doGenerateBins

protected <T> List<Bin<T>> doGenerateBins(List<Binnable<T>> objects,
                                          int numBins)

Generates equal-width bins. Determines the min/max from the objects.

Parameters:

numBins - the number of equal-width bins to generate

Returns:

the bins

doGenerateBins

protected <T> List<Bin<T>> doGenerateBins(com.github.fracpete.javautils.struct.Struct2<Double,Double> minMax,
                                          int numBins)

Generates equal-width bins.

Parameters:

minMax - the minimum/maximum to use

numBins - the number of equal-width bins to generate

Returns:

the bins

doGenerateBins

protected <T> List<Bin<T>> doGenerateBins(double min,
                                          double max,
                                          int numBins)

Generates equal-width bins.

Parameters:

min - the minimum to use

max - the maximum to use

numBins - the number of equal-width bins to generate

Returns:

the bins

doGenerateBins

protected <T> List<Bin<T>> doGenerateBins(List<Binnable<T>> objects,
                                          double binWidth)

Generates bins with the specified width. Determines the min/max from the objects.

Parameters:

binWidth - the bin width

Returns:

the bins

doGenerateBins

protected <T> List<Bin<T>> doGenerateBins(com.github.fracpete.javautils.struct.Struct2<Double,Double> minMax,
                                          double binWidth)

Generates bins with the specified width.

Parameters:

minMax - the minimum/maximum to use

binWidth - the bin width

Returns:

the bins

doGenerateBins

protected <T> List<Bin<T>> doGenerateBins(double min,
                                          double max,
                                          double binWidth)

Generates bins with the specified width.

Parameters:

min - the minimum to use

max - the maximum to use

binWidth - the bin width

Returns:

the bins