Package etomica.math.numerical

Class FiniteDifferenceDerivative

java.lang.Object

etomica.math.numerical.FiniteDifferenceDerivative

All Implemented Interfaces:

FunctionMultiDimensional, FunctionMultiDimensionalDifferentiable

public class FiniteDifferenceDerivative
extends java.lang.Object
implements FunctionMultiDimensionalDifferentiable

Field Summary

Fields

Modifier and Type	Field	Description
protected FunctionMultiDimensional	fFunction
protected double	h

Constructor Summary

Constructors

Constructor	Description
FiniteDifferenceDerivative(FunctionMultiDimensional fFunction)

Method Summary

Modifier and Type	Method	Description
double	df(int[] d, double[] u)	Returns the derivative indicated by the array d evaluated at the given point x.
double	f(double[] u)
int	getDimension()	The dimension of the space of independent variables.
double	getH()
void	setH(double h)

Methods inherited from class java.lang.Object

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

Field Detail

fFunction

protected FunctionMultiDimensional fFunction

h

protected double h

Constructor Detail

FiniteDifferenceDerivative

public FiniteDifferenceDerivative(FunctionMultiDimensional fFunction)

Method Detail

f

public double f(double[] u)

Specified by:

f in interface FunctionMultiDimensional

getDimension

public int getDimension()

Description copied from interface: FunctionMultiDimensional

The dimension of the space of independent variables. The length of the array passed to the f should be equal to this quantity.

Specified by:

getDimension in interface FunctionMultiDimensional

df

public double df(int[] d,
                 double[] u)

Description copied from interface: FunctionMultiDimensionalDifferentiable

Returns the derivative indicated by the array d evaluated at the given point x. The array d should be the same length as x. Each entry of d specifies the order of the derivative taken with respect to the corresponding variable in x. For example, for a function on a 2-dimensional space, d = {2,0}, indicates d2f/dx[0]^2, while d = {1,1}, indicates d2f/dx[0]dx[1]; d = {2,1} indicates d3f/dx[0]^2dx[1]; etc.

Specified by:

df in interface FunctionMultiDimensionalDifferentiable

getH

public double getH()

setH

public void setH(double h)