public class MultipleIterationsCondition extends AbstractTerminationCondition
TerminationCondition
requires another provided TerminationCondition
to fail a contiguous specified number of times
before the optimization is terminated.Modifier and Type | Class and Description |
---|---|
static class |
MultipleIterationsCondition.MultipleIterationsConditionParameterSet
This class implements the parameter set for a
MultipleIterationsCondition . |
AbstractTerminationCondition.AbstractTerminationConditionParameterSet
parameter
Constructor and Description |
---|
MultipleIterationsCondition(int threshold,
AbstractTerminationCondition condition)
This constructor creates an instance that stops the optimization if provided termination condition
fails a contiguously a specified number of times.
|
MultipleIterationsCondition(MultipleIterationsCondition.MultipleIterationsConditionParameterSet parameter)
This is the main constructor creating an instance from a given parameter set.
|
MultipleIterationsCondition(StringBuffer xml)
The standard constructor for the interface
Storable . |
Modifier and Type | Method and Description |
---|---|
boolean |
doNextIteration(int iteration,
double f_last,
double f_current,
double[] gradient,
double[] direction,
double alpha,
Time t)
This method allows to decide whether to do another iteration in an optimization or not.
|
protected String |
getXmlTag()
This method returns the xml tag that is used in the method
AbstractTerminationCondition.toXML() and
in the constructor AbstractTerminationCondition.AbstractTerminationCondition(StringBuffer) . |
boolean |
isSimple()
This method returns
false if the TerminationCondition uses either
the gradient or the direction for the decision, otherwise it returns true . |
protected void |
set()
This method sets internal member variables from
AbstractTerminationCondition.parameter . |
clone, getCurrentParameterSet, toXML
public MultipleIterationsCondition(int threshold, AbstractTerminationCondition condition) throws Exception
threshold
- the number of contiguous iterations the provided condition must fail to stop the optimizationcondition
- the condition for stopping the algorithmException
- if the parameter can not be set properlypublic MultipleIterationsCondition(MultipleIterationsCondition.MultipleIterationsConditionParameterSet parameter) throws CloneNotSupportedException
parameter
- the set of parametersCloneNotSupportedException
- if parameter
can not be cloned properly.public MultipleIterationsCondition(StringBuffer xml) throws NonParsableException
Storable
.
Constructs a MultipleIterationsCondition
out of an XML representation.xml
- the XML representation as StringBuffer
NonParsableException
- if the MultipleIterationsCondition
could not be reconstructed out of
the StringBuffer
xml
public boolean doNextIteration(int iteration, double f_last, double f_current, double[] gradient, double[] direction, double alpha, Time t)
TerminationCondition
true
it is recommended to do another iteration, otherwise
(the method returns false
and) it is recommended to stop the algorithm.iteration
- the number of performed iterationsf_last
- last value of the functionf_current
- current value of the functiongradient
- the gradient of the functiondirection
- the last direction of the optimizationalpha
- the last step sizet
- a time object measuring the time that has been elapsed in the optimizationtrue
if another iteration should be donepublic boolean isSimple()
TerminationCondition
false
if the TerminationCondition
uses either
the gradient or the direction for the decision, otherwise it returns true
.false
for gradient or direction based TerminationCondition
sprotected String getXmlTag()
AbstractTerminationCondition
AbstractTerminationCondition.toXML()
and
in the constructor AbstractTerminationCondition.AbstractTerminationCondition(StringBuffer)
.getXmlTag
in class AbstractTerminationCondition
protected void set()
AbstractTerminationCondition
AbstractTerminationCondition.parameter
.
It is used in the constructors.set
in class AbstractTerminationCondition