GradientGuidedPath (PULsE 1.98 API)

java.lang.Object
- pulse.search.direction.IterativeState
- - pulse.search.direction.GradientGuidedPath

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ComplexPath
```
public class GradientGuidedPath
extends IterativeState
```
A Path stores information relevant to the selected PathSolver, which is related to a specific SearchTask. This information is used by the PathSolver to perform the next search step.

This is the most basic implementation, which stores only the gradient, the direction (equal to the inverse gradient), minimum point achieved by the linear solver, and the number of current iteration. It is used in combination with the SteepestDescentSolver. Note the constructors for Path are protected, as they should not be invoked directly. Instead, they are invoked from within the PathSolver.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor Description

protected GradientGuidedPath(GeneralTask t)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`configure(GeneralTask t)`	Resets the `Path`: calculates the current gradient and the direction of search.Sets the minimum point to 0.0.
`Vector`	`getDirection()`
`Vector`	`getGradient()`
`double`	`getMinimumPoint()`
`void`	`setDirection(Vector currentDirection)`
`void`	`setGradient(Vector currentGradient)`
`void`	`setLinearStep(double min)`

Methods inherited from class pulse.search.direction.IterativeState
getCost, getFailedAttempts, getIteration, getParameters, incrementFailedAttempts, incrementStep, reset, resetFailedAttempts, setCost, setParameters

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

Constructor Detail

GradientGuidedPath

protected GradientGuidedPath(GeneralTask t)

Method Detail

configure
```
public void configure(GeneralTask t)
```
Resets the Path: calculates the current gradient and the direction of search.Sets the minimum point to 0.0.

Parameters:

t - the SearchTask, for which this Path is created.

getDirection
```
public Vector getDirection()
```

setDirection

public void setDirection(Vector currentDirection)

getGradient
```
public Vector getGradient()
```

setGradient

public void setGradient(Vector currentGradient)

getMinimumPoint
```
public double getMinimumPoint()
```

setLinearStep

public void setLinearStep(double min)