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

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.Option<T>
          de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameter<T,Number>
              de.lmu.ifi.dbs.elki.utilities.optionhandling.NumberParameter<Double>
                  de.lmu.ifi.dbs.elki.utilities.optionhandling.DoubleParameter

All Implemented Interfaces:

Loggable

public class DoubleParameter
extends NumberParameter<Double>

Parameter class for a parameter specifying a double value.

Author:

Steffi Wanka

Field Summary

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

constraints, defaultValue, optionalParameter

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

name, shortDescription, value

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug

Constructor Summary

DoubleParameter(OptionID optionID)
Constructs a double parameter with the given optionID.

DoubleParameter(OptionID optionID, boolean optional)
Constructs a double parameter with the given optionID, and optional flag.

DoubleParameter(OptionID optionID, List<ParameterConstraint<Number>> cons)
Constructs a double parameter with the given optionID, and parameter constraints.

DoubleParameter(OptionID optionID, List<ParameterConstraint<Number>> cons, boolean optional)
Constructs a double parameter with the given optionID, parameter constraints, and optional flag.

DoubleParameter(OptionID optionID, List<ParameterConstraint<Number>> cons, Double defaultValue)
Constructs a double parameter with the given optionID, parameter constraints, and default value.

DoubleParameter(OptionID optionID, ParameterConstraint<Number> cons)
Constructs a double parameter with the given optionID, and parameter constraint.

DoubleParameter(OptionID optionID, ParameterConstraint<Number> cons, boolean optional)
Constructs a double parameter with the given optionID, parameter constraint, and optional flag.

DoubleParameter(OptionID optionID, ParameterConstraint<Number> cons, Double defaultValue)
Constructs a double parameter with the given optionID, parameter constraint, and default value.

DoubleParameter(String name, String description)
Deprecated.

DoubleParameter(String name, String description, boolean optional)
Deprecated.

DoubleParameter(String name, String description, List<ParameterConstraint<Number>> cons)
Deprecated.

DoubleParameter(String name, String description, ParameterConstraint<Number> cons)
Deprecated.

DoubleParameter(String name, String description, ParameterConstraint<Number> cons, Double defaultValue)
Deprecated.

Method Summary

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
protected String	getParameterType() Returns a string representation of the parameter's type.
boolean	isValid(String value) Checks if the given argument is valid for this option.
void	setValue(String value) Sets the value of the option.

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

getNumberValue

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

addConstraint, addConstraintList, getDefaultValue, getDescription, getValue, hasDefaultValue, isOptional, isSet, reset, setDefaultValue, setDefaultValueToValue, setOptional, tookDefaultValue

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

getName, getShortDescription, setShortDescription

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleParameter

public DoubleParameter(OptionID optionID)

Constructs a double parameter with the given optionID.

Parameters:

optionID - the unique optionID

DoubleParameter

public DoubleParameter(OptionID optionID,
                       boolean optional)

Constructs a double parameter with the given optionID, and optional flag.

Parameters:

optionID - the unique optionID

optional - specifies whether this parameter is an optional parameter

DoubleParameter

public DoubleParameter(OptionID optionID,
                       ParameterConstraint<Number> cons)

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

Parameters:

optionID - the unique optionID

cons - the constraint for this double parameter

DoubleParameter

public DoubleParameter(OptionID optionID,
                       ParameterConstraint<Number> cons,
                       boolean optional)

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

Parameters:

optionID - the unique optionID

cons - the constraint for this double parameter

optional - specifies whether this parameter is an optional parameter

DoubleParameter

public DoubleParameter(OptionID optionID,
                       ParameterConstraint<Number> cons,
                       Double defaultValue)

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

Parameters:

optionID - the unique optionID

cons - the constraint for this double parameter

defaultValue - the default value for this double parameter

DoubleParameter

public DoubleParameter(OptionID optionID,
                       List<ParameterConstraint<Number>> cons)

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

Parameters:

optionID - the unique optionID

cons - a list of parameter constraints for this double parameter

DoubleParameter

public DoubleParameter(OptionID optionID,
                       List<ParameterConstraint<Number>> cons,
                       boolean optional)

Constructs a double parameter with the given optionID, parameter constraints, and optional flag.

Parameters:

optionID - the unique optionID

cons - a list of parameter constraints for this double parameter

optional - specifies whether this parameter is an optional parameter

DoubleParameter

public DoubleParameter(OptionID optionID,
                       List<ParameterConstraint<Number>> cons,
                       Double defaultValue)

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

Parameters:

optionID - the unique optionID

cons - a list of parameter constraints for this double parameter

defaultValue - the default value for this double parameter

DoubleParameter

@Deprecated
public DoubleParameter(String name,
                                  String description)

Deprecated.

Constructs a double parameter with the given name and description

Parameters:

name - the parameter name

description - the parameter description

DoubleParameter

@Deprecated
public DoubleParameter(String name,
                                  String description,
                                  boolean optional)

Deprecated.

Constructs a double parameter with the given name and description

Parameters:

name - the parameter name

description - the parameter description

optional - specifies if this parameter is an optional parameter

DoubleParameter

@Deprecated
public DoubleParameter(String name,
                                  String description,
                                  ParameterConstraint<Number> cons)

Deprecated.

Constructs a double parameter with the given name, description, and parameter constraint.

Parameters:

name - the parameter name

description - the parameter description

cons - the constraint for this double parameter

DoubleParameter

@Deprecated
public DoubleParameter(String name,
                                  String description,
                                  ParameterConstraint<Number> cons,
                                  Double defaultValue)

Deprecated.

Constructs a double parameter with the given name, description, parameter constraint, and defualt value.

Parameters:

name - the parameter name

description - the parameter description

cons - the constraint for this double parameter

defaultValue - the default value for this double parameter

DoubleParameter

@Deprecated
public DoubleParameter(String name,
                                  String description,
                                  List<ParameterConstraint<Number>> cons)

Deprecated.

Constructs a double parameter with the given name, description, and list of parameter constraints.

Parameters:

name - the parameter name

description - the parameter description

cons - a list of parameter constraints for this double parameter

Method Detail

setValue

public void setValue(String value)
              throws ParameterException

Description copied from class: Option

Sets the value of the option.

Specified by:

setValue in class Option<Double>

Parameters:

value - the option's value to be set

Throws:

ParameterException - if the given value is not a valid value for this option.

See Also:

Option.setValue(String)

isValid

public boolean isValid(String value)
                throws ParameterException

Description copied from class: Option

Checks if the given argument is valid for this option.

Specified by:

isValid in class Option<Double>

Parameters:

value - option value to be checked

Returns:

true, if the given value is valid for this option

Throws:

ParameterException - if the given value is not a valid value for this option.

See Also:

Option.isValid(String)

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this double parameter has the same value as the specified object, false otherwise.

getParameterType

protected String getParameterType()

Returns a string representation of the parameter's type.

Specified by:

getParameterType in class Parameter<Double,Number>

Returns:

"<double>"

See Also:

Parameter.getParameterType()