fr.cnes.sirius.patrius.math.analysis.differentiation

Class GradientFunction

java.lang.Object

fr.cnes.sirius.patrius.math.analysis.differentiation.GradientFunction

All Implemented Interfaces:

MultivariateVectorFunction

public class GradientFunction
extends Object
implements 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

Version:

$Id: GradientFunction.java 18108 2017-10-04 06:45:27Z bignon $

Constructor Summary

Constructors

Constructor and Description
GradientFunction(MultivariateDifferentiableFunction fIn) Simple constructor.

Method Summary

Modifier and Type	Method and Description
double[]	value(double[] point) Compute the value for the function at the given point.

Methods inherited from class java.lang.Object

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

Constructor Detail

GradientFunction

public GradientFunction(MultivariateDifferentiableFunction fIn)

Simple constructor.

Parameters:

fIn - underlying real-valued function

Method Detail

value

public double[] value(double[] point)

Compute the value for the function at the given point.

Specified by:

value in interface MultivariateVectorFunction

Parameters:

point - point at which the function must be evaluated

Returns:

function value for the given point