public class AbsoluteValueCondition extends AbstractTerminationCondition
Modifier and Type | Class and Description |
---|---|
static class |
AbsoluteValueCondition.AbsoluteValueConditionParameterSet
Deprecated.
This class implements the parameter set for a
AbsoluteValueCondition . |
AbstractTerminationCondition.AbstractTerminationConditionParameterSet
parameter
Constructor and Description |
---|
AbsoluteValueCondition(AbsoluteValueCondition.AbsoluteValueConditionParameterSet parameter)
Deprecated.
This is the main constructor creating an instance from a given parameter set.
|
AbsoluteValueCondition(double threshold)
Deprecated.
This constructor creates an instance that stops an minimization when the value of the function is below the given
threshold
Be careful! If you set the value too low the minimization will not terminate. |
AbsoluteValueCondition(StringBuffer xml)
Deprecated.
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)
Deprecated.
This method allows to decide whether to do another iteration in an optimization or not.
|
protected String |
getXmlTag()
Deprecated.
This method returns the xml tag that is used in the method
AbstractTerminationCondition.toXML() and
in the constructor AbstractTerminationCondition.AbstractTerminationCondition(StringBuffer) . |
boolean |
isSimple()
Deprecated.
This method returns
false if the TerminationCondition uses either
the gradient or the direction for the decision, otherwise it returns true . |
protected void |
set()
Deprecated.
This method sets internal member variables from
AbstractTerminationCondition.parameter . |
clone, getCurrentParameterSet, toXML
public AbsoluteValueCondition(double threshold) throws Exception
threshold
threshold
- the threshold for stopping the optimizationException
- if the parameter can not be set properlypublic AbsoluteValueCondition(AbsoluteValueCondition.AbsoluteValueConditionParameterSet parameter) throws CloneNotSupportedException
parameter
- the set of parametersCloneNotSupportedException
- if parameter
can not be cloned properly.public AbsoluteValueCondition(StringBuffer xml) throws NonParsableException
Storable
.
Constructs a AbsoluteValueCondition
out of an XML representation.xml
- the XML representation as StringBuffer
NonParsableException
- if the AbsoluteValueCondition
could not be reconstructed out of
the StringBuffer
xml
protected void set()
AbstractTerminationCondition
AbstractTerminationCondition.parameter
.
It is used in the constructors.set
in class AbstractTerminationCondition
protected String getXmlTag()
AbstractTerminationCondition
AbstractTerminationCondition.toXML()
and
in the constructor AbstractTerminationCondition.AbstractTerminationCondition(StringBuffer)
.getXmlTag
in class AbstractTerminationCondition
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
s