Package adams.data.binning.algorithm

Interface BinningAlgorithm

Type Parameters:

T - the type of payload

All Superinterfaces:

Destroyable, OptionHandler, QuickInfoSupporter

All Known Subinterfaces:

FixedBinWidthBinningAlgorithm, FixedNumBinsBinningAlgorithm

All Known Implementing Classes:

AbstractBinningAlgorithm, AbstractEqualWidthBinningAlgorithm, DensityBinning, FreedmanDiaconisChoiceBinning, FrequencyBinning, ManualBinning, NoBinning, RiceRuleBinning, ScottsNormalReferenceRuleBinning, SquareRootChoiceBinning, SturgesFormulaBinning

public interface BinningAlgorithm
extends OptionHandler, QuickInfoSupporter

Interface for binning algorithms.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
<T> List<Bin<T>>	generateBins(List<Binnable<T>> objects)	Performs the bin generation on the provided objects.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Method Detail

generateBins

<T> List<Bin<T>> generateBins(List<Binnable<T>> objects)

Performs the bin generation on the provided objects.

Parameters:

objects - the objects to bin

Returns:

the generated bins

Throws:

IllegalStateException - if check or binning fails