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
Class ConstantStartDistance

    java.lang.Object
      de.jstacs.algorithms.optimization.ConstantStartDistance

All Implemented Interfaces:
  StartDistanceForecaster

    public class ConstantStartDistance

extends Object
implements StartDistanceForecaster

The most simple `StartDistanceForecaster` that returns always the same value.

Author:
  Jens Keilwagen

Constructor Summary
`ConstantStartDistance(double value)` This constructor creates an instance of `ConstantStartDistance` that returns always the given `value`.

Method Summary
`double` | `getNewStartDistance()` This method returns the new positive start distance.
`void` | `reset()` Resets the object to the initial state.
`void` | `setLastDistance(double last)` Sets the last used distance.

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

Constructor Detail

### ConstantStartDistance

    public ConstantStartDistance(double value)

  This constructor creates an instance of `ConstantStartDistance` that returns always the given `value`.

  Parameters:
    `value` - the value that will always be returned

Method Detail

### getNewStartDistance

    public double getNewStartDistance()

  Description copied from interface: `StartDistanceForecaster`
  This method returns the new positive start distance. It enables the implementor to compute any interpolation using the last values.

  Specified by:
    `getNewStartDistance` in interface `StartDistanceForecaster`
  Returns:
    the new positive start distance
  See Also:
    `StartDistanceForecaster.setLastDistance(double)`

### setLastDistance

    public void setLastDistance(double last)

  Description copied from interface: `StartDistanceForecaster`
  Sets the last used distance.

  Specified by:
    `setLastDistance` in interface `StartDistanceForecaster`
  Parameters:
    `last` - the last used distance

### reset

    public void reset()

  Description copied from interface: `StartDistanceForecaster`
  Resets the object to the initial state.

  Specified by:
    `reset` in interface `StartDistanceForecaster`

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