Package | Description |
---|---|
de.lmu.ifi.dbs.elki.utilities.optionhandling |
Parameter handling and option descriptions.
|
de.lmu.ifi.dbs.elki.utilities.optionhandling.constraints |
Constraints allow to restrict possible values for parameters
|
de.lmu.ifi.dbs.elki.utilities.optionhandling.parameterization |
Configuration managers
See the
de.lmu.ifi.dbs.elki.utilities.optionhandling package for
documentation! |
de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters |
Classes for various typed parameters
See the
de.lmu.ifi.dbs.elki.utilities.optionhandling package for
documentation! |
Modifier and Type | Class and Description |
---|---|
class |
InternalParameterizationErrors
Pseudo error class that wraps multiple error reports into one.
|
class |
UnspecifiedParameterException
Exception when a required parameter was not given.
|
class |
WrongParameterValueException
Thrown by a Parameterizable object in case of wrong parameter format.
|
Modifier and Type | Method and Description |
---|---|
void |
LessConstraint.test(java.lang.Number t)
Checks if the number value given by the number parameter is less than the
constraint value.
|
void |
LessEqualConstraint.test(java.lang.Number t)
Checks if the number value given by the number parameter is less equal than
the constraint value.
|
void |
GreaterConstraint.test(java.lang.Number t)
Checks if the number value given by the number parameter is greater than
the constraint value.
|
void |
GreaterEqualConstraint.test(java.lang.Number t)
Checks if the number value given by the number parameter is greater equal
than the constraint value.
|
void |
ListSizeConstraint.test(java.lang.Object t)
Checks if the list parameter fulfills the size constraint.
|
void |
ParameterConstraint.test(T t)
Checks if the value
t of the parameter to be tested fulfills the
parameter constraint. |
void |
ListEachNumberConstraint.test(T t) |
Modifier and Type | Field and Description |
---|---|
(package private) java.util.List<ParameterException> |
UnParameterization.errors
Errors
|
(package private) java.util.List<ParameterException> |
AbstractParameterization.errors
Errors
|
Modifier and Type | Method and Description |
---|---|
java.util.Collection<ParameterException> |
UnParameterization.getErrors() |
java.util.Collection<ParameterException> |
Parameterization.getErrors()
Get the configuration errors thrown in
Parameterization.grab(de.lmu.ifi.dbs.elki.utilities.optionhandling.parameters.Parameter<?>) |
java.util.Collection<ParameterException> |
TrackParameters.getErrors() |
java.util.Collection<ParameterException> |
MergedParameterization.getErrors() |
java.util.Collection<ParameterException> |
AbstractParameterization.getErrors() |
Modifier and Type | Method and Description |
---|---|
void |
UnParameterization.reportError(ParameterException e) |
void |
Parameterization.reportError(ParameterException e)
Report a configuration error.
|
void |
TrackParameters.reportError(ParameterException e) |
void |
MergedParameterization.reportError(ParameterException e) |
void |
ChainedParameterization.reportError(ParameterException e) |
void |
AbstractParameterization.reportError(ParameterException e) |
Modifier and Type | Method and Description |
---|---|
boolean |
ListParameterization.setValueForOption(Parameter<?> opt) |
boolean |
Parameterization.setValueForOption(Parameter<?> opt)
Assign a value for an option, but not using default values and throwing
exceptions on error.
|
boolean |
TrackParameters.setValueForOption(Parameter<?> opt) |
boolean |
MergedParameterization.setValueForOption(Parameter<?> opt) |
boolean |
SerializedParameterization.setValueForOption(Parameter<?> opt) |
boolean |
ChainedParameterization.setValueForOption(Parameter<?> opt) |
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractParameter.isValid(java.lang.Object obj) |
boolean |
Parameter.isValid(java.lang.Object obj)
Checks if the given argument is valid for this option.
|
protected java.lang.String |
StringParameter.parseValue(java.lang.Object obj) |
protected int[] |
IntListParameter.parseValue(java.lang.Object obj) |
protected java.lang.Integer |
IntParameter.parseValue(java.lang.Object obj) |
protected abstract T |
AbstractParameter.parseValue(java.lang.Object obj)
Parse a given value into the destination type.
|
protected java.lang.Class<? extends C> |
ObjectParameter.parseValue(java.lang.Object obj) |
protected double[] |
DoubleListParameter.parseValue(java.lang.Object obj) |
protected java.lang.Long |
LongParameter.parseValue(java.lang.Object obj) |
protected RandomFactory |
RandomParameter.parseValue(java.lang.Object obj) |
protected E |
EnumParameter.parseValue(java.lang.Object obj) |
protected IntGenerator |
IntGeneratorParameter.parseValue(java.lang.Object obj) |
protected java.util.List<java.io.File> |
FileListParameter.parseValue(java.lang.Object obj) |
protected java.lang.Class<? extends C> |
ClassParameter.parseValue(java.lang.Object obj) |
protected java.io.File |
FileParameter.parseValue(java.lang.Object obj) |
protected java.util.List<java.lang.Class<? extends C>> |
ObjectListParameter.parseValue(java.lang.Object obj) |
protected java.util.List<double[]> |
DoubleArrayListParameter.parseValue(java.lang.Object obj) |
protected java.util.regex.Pattern |
PatternParameter.parseValue(java.lang.Object obj) |
protected java.util.List<java.lang.Class<? extends C>> |
ClassListParameter.parseValue(java.lang.Object obj) |
protected java.lang.Boolean |
Flag.parseValue(java.lang.Object obj) |
void |
AbstractParameter.setValue(java.lang.Object obj) |
void |
ObjectParameter.setValue(java.lang.Object obj) |
void |
RandomParameter.setValue(java.lang.Object obj) |
void |
Parameter.setValue(java.lang.Object obj)
Sets the value of the option.
|
protected boolean |
Flag.validate(java.lang.Boolean obj) |
boolean |
ClassParameter.validate(java.lang.Class<? extends C> obj)
Checks if the given parameter value is valid for this ClassParameter.
|
protected boolean |
FileParameter.validate(java.io.File obj) |
protected boolean |
ClassListParameter.validate(java.util.List<java.lang.Class<? extends C>> obj) |
protected boolean |
FileListParameter.validate(java.util.List<java.io.File> obj) |
protected boolean |
AbstractParameter.validate(T obj)
Validate a value after parsing (e.g. do constraint checks!)
|
Copyright © 2019 ELKI Development Team. License information.