Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## de.jstacs.algorithms.optimization.termination
Class AbstractTerminationCondition.AbstractTerminationConditionParameterSet

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

All Implemented Interfaces:
  RangeIterator, Storable, Cloneable

Direct Known Subclasses:
  AbsoluteValueCondition.AbsoluteValueConditionParameterSet, CombinedCondition.CombinedConditionParameterSet, IterationCondition.IterationConditionParameterSet, SmallDifferenceOfFunctionEvaluationsCondition.SmallDifferenceOfFunctionEvaluationsConditionParameterSet, SmallGradientConditon.SmallGradientConditonParameterSet, SmallStepCondition.SmallStepConditionParameterSet, TimeCondition.TimeConditionParameterSet

Enclosing class:
  AbstractTerminationCondition

    public abstract static class AbstractTerminationCondition.AbstractTerminationConditionParameterSet

extends InstanceParameterSet

This class implements the super class of all parameter sets of instances from `AbstractTerminationCondition`.

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
`AbstractTerminationCondition.AbstractTerminationConditionParameterSet(Class<? extends AbstractTerminationCondition> instanceClass)` Constructs an `AbstractTerminationCondition.AbstractTerminationConditionParameterSet` from the class that can be instantiated using this `AbstractTerminationCondition.AbstractTerminationConditionParameterSet`.
`AbstractTerminationCondition.AbstractTerminationConditionParameterSet(StringBuffer representation)` The standard constructor for the interface `Storable`.

Method Summary
`AbstractTerminationCondition.AbstractTerminationConditionParameterSet` | `clone()` Creates a full clone (deep copy) of this `ParameterSet`.

Methods inherited from class de.jstacs.parameters.InstanceParameterSet
`fromXML, getInstance, getInstanceClass, getInstanceComment, getInstanceName, toXML`

Methods inherited from class de.jstacs.parameters.ParameterSet
`getErrorMessage, getId, getIndex, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, loadParameters, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setParent, simplify, valuesToString`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### AbstractTerminationCondition.AbstractTerminationConditionParameterSet

    public AbstractTerminationCondition.AbstractTerminationConditionParameterSet(Class<? extends AbstractTerminationCondition> instanceClass)
                                                                          throws IllegalArgumentException

  Constructs an `AbstractTerminationCondition.AbstractTerminationConditionParameterSet` from the class that can be instantiated using this `AbstractTerminationCondition.AbstractTerminationConditionParameterSet`. The set of parameters is loaded by the `ParameterSet.loadParameters()`-method if this `AbstractTerminationCondition.AbstractTerminationConditionParameterSet` is expected to be filled with values.

  Parameters:
    `instanceClass` - the class to be instantiated
  Throws:
    `IllegalArgumentException` - if `instanceClass` is null

### AbstractTerminationCondition.AbstractTerminationConditionParameterSet

    public AbstractTerminationCondition.AbstractTerminationConditionParameterSet(StringBuffer representation)
                                                                          throws NonParsableException

  The standard constructor for the interface `Storable`. Constructs an `AbstractTerminationCondition.AbstractTerminationConditionParameterSet` out of an XML representation.

  Parameters:
    `representation` - the XML representation as `StringBuffer`
  Throws:
    `NonParsableException` - if the `AbstractTerminationCondition.AbstractTerminationConditionParameterSet` could not be reconstructed out of the `StringBuffer` `representation`

Method Detail

### clone

    public AbstractTerminationCondition.AbstractTerminationConditionParameterSet clone()
                                                                                throws CloneNotSupportedException

  Description copied from class: `ParameterSet`
  Creates a full clone (deep copy) of this `ParameterSet`. As a convenience-method the user can use `fillWithStandardFieldsForClone(ParameterSet)` on a newly created instance of a subclass of `ParameterSet` to obtain a clone/copy of all standard member variables (those already defined in `ParameterSet`) in the passed `ParameterSet`. Using this method, the cloning process becomes merely three-step:
  - Create a new instance of your subclass of `ParameterSet`, most likely with an empty constructor or the one taking just the instance class.
  - Call `this.fillWithStandardFieldsForClone` on this instance.
  - Return the instance.
  This method fulfills the conventions of `Object`'s method `Object.clone()`.

  Overrides:
    `clone` in class `ParameterSet`
  Returns:
    a deep clone/copy of this `ParameterSet`
  Throws:
    `CloneNotSupportedException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD