org.ddogleg.optimization.impl

Class NumericalDerivativeForward

java.lang.Object

org.ddogleg.optimization.impl.NumericalDerivativeForward

All Implemented Interfaces:

FunctionStoS

public class NumericalDerivativeForward
extends java.lang.Object
implements FunctionStoS

Finite difference numerical gradient calculation using forward equation. Forward difference equation, f'(x) = f(x+h)-f(x)/h. Scaling is taken in account by h based upon the magnitude of the elements in variable x.

NOTE: If multiple input parameters are modified by the function when a single one is changed numerical derivatives aren't reliable.

Constructor Summary

Constructors

Constructor and Description
NumericalDerivativeForward(FunctionStoS function)
NumericalDerivativeForward(FunctionStoS function, double differenceScale)

Method Summary

Modifier and Type	Method and Description
double	process(double x) Processes the input to compute an output.

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericalDerivativeForward

public NumericalDerivativeForward(FunctionStoS function,
                                  double differenceScale)

NumericalDerivativeForward

public NumericalDerivativeForward(FunctionStoS function)

Method Detail

process

public double process(double x)

Description copied from interface: FunctionStoS

Processes the input to compute an output.

Specified by:

process in interface FunctionStoS

Parameters:

x - input parameter

Returns:

output value