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

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet

errorMessage, parameters, parent

Constructor Summary

Constructors

Constructor and Description
MultipleIterationsConditionParameterSet() This constructor creates an empty parameter set.
MultipleIterationsConditionParameterSet(int threshold, AbstractTerminationCondition condition) This constructor creates a filled instance of the parameter set.
MultipleIterationsConditionParameterSet(StringBuffer xml) The standard constructor for the interface Storable.

Method Summary

Modifier and Type	Method and Description
String	getInstanceComment() Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.
String	getInstanceName() Returns the name of an instance of the class that can be constructed using this ParameterSet.

Methods inherited from class de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet

clone

Methods inherited from class de.jstacs.parameters.InstanceParameterSet

fromXML, getInstance, getInstanceClass, toXML

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleIterationsConditionParameterSet

public MultipleIterationsConditionParameterSet()
                                        throws Exception

This constructor creates an empty parameter set.

Throws:

Exception - if some error occurs

MultipleIterationsConditionParameterSet

public 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

MultipleIterationsConditionParameterSet

public 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 optimization

condition - the condition for stopping the algorithm

Throws:

Exception - if the MultipleIterationsCondition.MultipleIterationsConditionParameterSet could not be created

Method Detail

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