de.lmu.ifi.dbs.elki.utilities.optionhandling
Class VectorListParameter
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<List<T>,List<T>>
de.lmu.ifi.dbs.elki.utilities.optionhandling.ListParameter<List<Double>>
de.lmu.ifi.dbs.elki.utilities.optionhandling.VectorListParameter
- All Implemented Interfaces:
- Loggable
public class VectorListParameter
- extends ListParameter<List<Double>>
Parameter class for a parameter specifying a list of vectors.
- Author:
- Steffi Wanka
Method Summary |
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. |
int[] |
vectorSizes()
Returns an array containing the individual vector sizes of this vector list parameter. |
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.logging.AbstractLoggable |
debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, verbose, warning |
VectorListParameter
@Deprecated
public VectorListParameter(String name,
String description)
- Deprecated.
- Constructs a vector list parameter with the given name and description.
- Parameters:
name
- the parameter namedescription
- the parameter description
VectorListParameter
@Deprecated
public VectorListParameter(String name,
String description,
ParameterConstraint<List<List<Double>>> con)
- Deprecated.
- Constructs a vector list parameter with the given name, description, and parameter constraint.
- Parameters:
name
- the parameter namedescription
- the parameter descriptioncon
- a parameter constraint
VectorListParameter
public VectorListParameter(String name,
String description,
List<ParameterConstraint<List<List<Double>>>> cons)
- Constructs a vector list parameter with the given name, description, and list of parameter constraints.
- Parameters:
name
- the parameter namedescription
- the parameter descriptioncons
- a list of parameter constraints
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<List<List<Double>>>
- Parameters:
value
- the option's value to be set
- Throws:
ParameterException
- if the given value is not a valid value for this option.
vectorSizes
public int[] vectorSizes()
- Returns an array containing the individual vector sizes of this vector list parameter.
- Returns:
- the individual vector sizes
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<List<List<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.
getParameterType
protected String getParameterType()
- Returns a string representation of the parameter's type.
- Specified by:
getParameterType
in class Parameter<List<List<Double>>,List<List<Double>>>
- Returns:
- "<double_11,...,double_1n:...:double_m1,...,double_mn>"
- See Also:
Parameter.getParameterType()