Top Description Fields Constructors Methods
org.apache.commons.math3.analysis.differentiation

public Class GradientFunction

extends Object
implements MultivariateVectorFunction
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.analysis.MultivariateVectorFunction
Imports
org.apache.commons.math3.analysis.MultivariateVectorFunction
Class representing the gradient of a multivariate function.

The vectorial components of the function represent the derivatives with respect to each function parameters.

Since
3.1

Field Summary

Modifier and TypeField and Description
private final MultivariateDifferentiableFunction
f

Underlying real-valued function.

Constructor Summary

AccessConstructor and Description
public
GradientFunction(final MultivariateDifferentiableFunction
underlying real-valued function
f)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
public double[]
value(double[]
point at which the function must be evaluated
point)

Implements org.apache.commons.math3.analysis.MultivariateVectorFunction.value.

Compute the value for the function at the given point.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fback to summary
private final MultivariateDifferentiableFunction f

Underlying real-valued function.

Constructor Detail

GradientFunctionback to summary
public GradientFunction(final MultivariateDifferentiableFunction f)

Simple constructor.

Parameters
f:MultivariateDifferentiableFunction

underlying real-valued function

Method Detail

valueback to summary
public double[] value(double[] point)

Implements org.apache.commons.math3.analysis.MultivariateVectorFunction.value.

Doc from org.apache.commons.math3.analysis.MultivariateVectorFunction.value.

Compute the value for the function at the given point.

Parameters
point:double[]

point at which the function must be evaluated

Returns:double[]

function value for the given point