Package adams.data.statistics
Class ArrayMin<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.ArrayMin<T>
-
- Type Parameters:
T- the data to process
- All Implemented Interfaces:
AdditionalInformationHandler,Destroyable,GlobalInfoSupporter,LoggingLevelHandler,LoggingSupporter,OptionHandler,ShallowCopySupporter<AbstractArrayStatistic>,SizeOfHandler,Serializable
public class ArrayMin<T extends Number> extends AbstractArrayStatistic<T>
Determines the min value in a numeric array.
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
-return-index (property: returnIndex) If set to true, then the 0-based index of the value is returned instead the actual value.
- Version:
- $Revision$
- 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 Modifier and Type Field Description protected booleanm_ReturnIndexwhether to return the index instead of the actual value.-
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 ArrayMin()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddefineOptions()Adds options to the internal list of options.protected AbstractArrayStatistic.StatisticContainerdoCalculate()Generates the actual result.intgetMax()Returns the maximum number of arrays that need to be present.intgetMin()Returns the minimum number of arrays that need to be present.booleangetReturnIndex()Returns whether to return the index instead of the actual value.StringglobalInfo()Returns a string describing the object.StringreturnIndexTipText()Returns the tip text for this property.voidsetReturnIndex(boolean value)Sets whether to return the index instead of the actual value.-
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, 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
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractOptionHandler
-
setReturnIndex
public void setReturnIndex(boolean value)
Sets whether to return the index instead of the actual value.- Parameters:
value- if true then the index is returned instead of the value
-
getReturnIndex
public boolean getReturnIndex()
Returns whether to return the index instead of the actual value.- Returns:
- true if the index is returned instead of the value
-
returnIndexTipText
public String returnIndexTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getMin
public int getMin()
Returns the minimum number of arrays that need to be present. -1 for unbounded.- Specified by:
getMinin classAbstractArrayStatistic<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:
getMaxin classAbstractArrayStatistic<T extends Number>- Returns:
- the maximum number, -1 for unbounded
-
doCalculate
protected AbstractArrayStatistic.StatisticContainer doCalculate()
Generates the actual result.- Specified by:
doCalculatein classAbstractArrayStatistic<T extends Number>- Returns:
- the generated result
-
-