Package adams.data.distribution

Class Cauchy

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.distribution.AbstractRealDistribution

adams.data.distribution.Cauchy

All Implemented Interfaces:

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

public class Cauchy
extends AbstractRealDistribution

Cauchy distribution.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

CauchyDistribution, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Median	the median parameter.
protected double	m_Scale	the scale parameter.

Fields inherited from class adams.data.distribution.AbstractRealDistribution

m_Distribution

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
double	getMedian()	Returns the median.
org.apache.commons.math3.distribution.RealDistribution	getRealDistribution()	Returns the configured distribution.
double	getScale()	Returns the scale.
String	globalInfo()	Returns a string describing the object.
String	medianTipText()	Returns the tip text for this property.
String	scaleTipText()	Returns the tip text for this property.
void	setMedian(double value)	Sets the median.
void	setScale(double value)	Sets the scale.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Field Detail

m_Median

protected double m_Median

the median parameter.

m_Scale

protected double m_Scale

the scale parameter.

Constructor Detail

Cauchy

public Cauchy()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setMedian

public void setMedian(double value)

Sets the median.

Parameters:

value - the median

getMedian

public double getMedian()

Returns the median.

Returns:

the median

medianTipText

public String medianTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setScale

public void setScale(double value)

Sets the scale.

Parameters:

value - the scale

getScale

public double getScale()

Returns the scale.

Returns:

the scale

scaleTipText

public String scaleTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getRealDistribution

public org.apache.commons.math3.distribution.RealDistribution getRealDistribution()

Returns the configured distribution.

Specified by:

getRealDistribution in class AbstractRealDistribution

Returns:

the distribution