de.jstacs.algorithms.optimization.termination
Class MultipleIterationsCondition.MultipleIterationsConditionParameterSet
java.lang.Object
de.jstacs.parameters.ParameterSet
de.jstacs.parameters.InstanceParameterSet<AbstractTerminationCondition>
de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet
de.jstacs.algorithms.optimization.termination.MultipleIterationsCondition.MultipleIterationsConditionParameterSet
- All Implemented Interfaces:
- GalaxyConvertible, Storable, Cloneable
- Enclosing class:
- MultipleIterationsCondition
public static class MultipleIterationsCondition.MultipleIterationsConditionParameterSet
- extends AbstractTerminationCondition.AbstractTerminationConditionParameterSet
This class implements the parameter set for a MultipleIterationsCondition
.
- Author:
- Jan Grau, Jens Keilwagen
Methods inherited from class de.jstacs.parameters.ParameterSet |
fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy |
MultipleIterationsCondition.MultipleIterationsConditionParameterSet
public MultipleIterationsCondition.MultipleIterationsConditionParameterSet()
throws Exception
- This constructor creates an empty parameter set.
- Throws:
Exception
- if some error occurs
MultipleIterationsCondition.MultipleIterationsConditionParameterSet
public MultipleIterationsCondition.MultipleIterationsConditionParameterSet(StringBuffer xml)
throws NonParsableException
- The standard constructor for the interface
Storable
.
Constructs an MultipleIterationsCondition.MultipleIterationsConditionParameterSet
out of an XML representation.
- Parameters:
xml
- the XML representation as StringBuffer
- Throws:
NonParsableException
- if the MultipleIterationsCondition.MultipleIterationsConditionParameterSet
could not be
reconstructed out of the StringBuffer
representation
MultipleIterationsCondition.MultipleIterationsConditionParameterSet
public MultipleIterationsCondition.MultipleIterationsConditionParameterSet(int threshold,
AbstractTerminationCondition condition)
throws Exception
- This constructor creates a filled instance of the parameter set.
- Parameters:
threshold
- the number of contiguous iterations the provided condition must fail to stop the optimizationcondition
- the condition for stopping the algorithm
- Throws:
Exception
- if the MultipleIterationsCondition.MultipleIterationsConditionParameterSet
could not be created
getInstanceComment
public String getInstanceComment()
- Description copied from class:
InstanceParameterSet
- Returns a comment (a textual description) of the class that can be
constructed using this
ParameterSet
.
- Specified by:
getInstanceComment
in class InstanceParameterSet<AbstractTerminationCondition>
- Returns:
- the comment of the class
getInstanceName
public String getInstanceName()
- Description copied from class:
InstanceParameterSet
- Returns the name of an instance of the class that can be constructed
using this
ParameterSet
.
- Specified by:
getInstanceName
in class InstanceParameterSet<AbstractTerminationCondition>
- Returns:
- the name of the class