de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters

Class DoubleParameter

java.lang.Object

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter<T>

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.NumberParameter<Double>

de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.DoubleParameter

All Implemented Interfaces:

Parameter<Double>

public class DoubleParameter
extends NumberParameter<Double>

Parameter class for a parameter specifying a double value.

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter

constraints, defaultValue, givenValue, optionalParameter, optionid, shortDescription

Constructor Summary

Constructors

Constructor and Description
DoubleParameter(OptionID optionID) Constructs a double parameter with the given optionID.
DoubleParameter(OptionID optionID, boolean optional) Deprecated. Use AbstractParameter.setOptional(boolean) instead.
DoubleParameter(OptionID optionID, double defaultValue) Constructs a double parameter with the given optionID and default value.
DoubleParameter(OptionID optionID, double defaultValue, ParameterConstraint<Number> constraint) Deprecated. Use AbstractParameter.addConstraint(de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.ParameterConstraint<? super T>) instead.
DoubleParameter(OptionID optionID, ParameterConstraint<Number> constraint) Deprecated. Use AbstractParameter.addConstraint(de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.ParameterConstraint<? super T>) instead.

Method Summary

Methods

Modifier and Type	Method and Description
double	doubleValue() Get the parameter value as double.
String	getSyntax() Returns a string representation of the parameter's type.
String	getValueAsString() Get the value as string.
protected Double	parseValue(Object obj) Parse a given value into the destination type.

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.AbstractParameter

addConstraint, addConstraints, getDefaultValue, getDefaultValueAsString, getFullDescription, getGivenValue, getName, getOptionID, getShortDescription, getValue, getValuesDescription, hasDefaultValue, hasValuesDescription, isDefined, isOptional, isValid, setDefaultValue, setOptional, setShortDescription, setValue, setValueInternal, tookDefaultValue, tryDefaultValue, useDefaultValue, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DoubleParameter

@Deprecated
public DoubleParameter(OptionID optionID,
                          double defaultValue,
                          ParameterConstraint<Number> constraint)

Deprecated. Use AbstractParameter.addConstraint(de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.ParameterConstraint<? super T>) instead.

Constructs a double parameter with the given optionID, parameter constraint, and default value.

Parameters:

optionID - the unique id of this parameter

defaultValue - the default value for this parameter

constraint - the constraint of this parameter

DoubleParameter

@Deprecated
public DoubleParameter(OptionID optionID,
                          ParameterConstraint<Number> constraint)

Deprecated. Use AbstractParameter.addConstraint(de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints.ParameterConstraint<? super T>) instead.

Constructs a double parameter with the given optionID, and parameter constraint.

Parameters:

optionID - the unique id of this parameter

constraint - the constraint of this parameter

DoubleParameter

public DoubleParameter(OptionID optionID,
               double defaultValue)

Constructs a double parameter with the given optionID and default value.

Parameters:

optionID - the unique optionID

defaultValue - the default value for this double parameter

DoubleParameter

@Deprecated
public DoubleParameter(OptionID optionID,
                          boolean optional)

Deprecated. Use AbstractParameter.setOptional(boolean) instead.

Constructs a double parameter with the given optionID and default value.

Parameters:

optionID - the unique optionID

optional - Flag to indicate that the parameter is optional

DoubleParameter

public DoubleParameter(OptionID optionID)

Constructs a double parameter with the given optionID.

Parameters:

optionID - the unique id of this parameter

Method Detail

getValueAsString

public String getValueAsString()

Description copied from interface: Parameter

Get the value as string. May return null

Specified by:

getValueAsString in interface Parameter<Double>

Specified by:

getValueAsString in class AbstractParameter<Double>

Returns:

Value as string

parseValue

protected Double parseValue(Object obj)
                     throws WrongParameterValueException

Description copied from class: AbstractParameter

Parse a given value into the destination type.

Specified by:

parseValue in class AbstractParameter<Double>

Parameters:

obj - Object to parse (may be a string representation!)

Returns:

Parsed object

Throws:

WrongParameterValueException

getSyntax

public String getSyntax()

Returns a string representation of the parameter's type.

Specified by:

getSyntax in interface Parameter<Double>

Specified by:

getSyntax in class AbstractParameter<Double>

Returns:

"<double>"

doubleValue

public double doubleValue()

Get the parameter value as double.

Returns:

double value