de.jstacs.algorithms.optimization.termination
Class SmallGradientConditon.SmallGradientConditonParameterSet

java.lang.Object
  de.jstacs.parameters.ParameterSet
      de.jstacs.parameters.InstanceParameterSet
          de.jstacs.algorithms.optimization.termination.AbstractTerminationCondition.AbstractTerminationConditionParameterSet
              de.jstacs.algorithms.optimization.termination.SmallGradientConditon.SmallGradientConditonParameterSet

All Implemented Interfaces:

GalaxyConvertible, RangeIterator, Storable, Cloneable

Enclosing class:

SmallGradientConditon

public static class SmallGradientConditon.SmallGradientConditonParameterSet
extends AbstractTerminationCondition.AbstractTerminationConditionParameterSet

This class implements the parameter set for a SmallStepCondition.

Author:

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, ranged

Constructor Summary

SmallGradientConditon.SmallGradientConditonParameterSet()
This constructor creates an empty parameter set.

SmallGradientConditon.SmallGradientConditonParameterSet(double eps)
This constructor creates a filled instance of a parameters set.

SmallGradientConditon.SmallGradientConditonParameterSet(StringBuffer xml)
The standard constructor for the interface Storable.

Method Summary

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.
protected void	loadParameters() Loads the parameters for 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, getErrorMessage, getId, getIndex, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setParent, simplify, toGalaxy, valuesToString

Methods inherited from class java.lang.Object

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

Constructor Detail

SmallGradientConditon.SmallGradientConditonParameterSet

public SmallGradientConditon.SmallGradientConditonParameterSet()

This constructor creates an empty parameter set.

SmallGradientConditon.SmallGradientConditonParameterSet

public SmallGradientConditon.SmallGradientConditonParameterSet(StringBuffer xml)
                                                        throws NonParsableException

The standard constructor for the interface Storable. Constructs an SmallStepCondition out of an XML representation.

Parameters:

xml - the XML representation as StringBuffer

Throws:

NonParsableException - if the SmallStepCondition could not be reconstructed out of the StringBuffer representation

SmallGradientConditon.SmallGradientConditonParameterSet

public SmallGradientConditon.SmallGradientConditonParameterSet(double eps)
                                                        throws IllegalArgumentException,
                                                               SimpleParameter.IllegalValueException

This constructor creates a filled instance of a parameters set.

Parameters:

eps - the epsilon for the gradient

Throws:

IllegalArgumentException - if parameter can not be set

SimpleParameter.IllegalValueException - if parameter can not be set

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

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

Returns:

the name of the class

loadParameters

protected void loadParameters()
                       throws Exception

Description copied from class: ParameterSet

Loads the parameters for this ParameterSet. This is in most cases done by calling ParameterSet.initParameterList() or ParameterSet.initParameterList(int) to initialize ParameterSet.parameters and afterwards filling ParameterSet.parameters with instances of subclasses of Parameter.

Specified by:

loadParameters in class ParameterSet

Throws:

Exception - if the parameters could not be loaded

See Also:

Parameter, ParameterSet.parameters, ParameterSet.initParameterList(), ParameterSet.initParameterList(int)