org.hipparchus.analysis.differentiation

Interface Derivative<T extends CalculusFieldElement<T>>

Type Parameters:

T - the type of the field elements

All Superinterfaces:

CalculusFieldElement<T>, FieldElement<T>

All Known Implementing Classes:

DerivativeStructure, Gradient, UnivariateDerivative, UnivariateDerivative1, UnivariateDerivative2

public interface Derivative<T extends CalculusFieldElement<T>>
extends CalculusFieldElement<T>

Interface representing both the value and the differentials of a function.

Since:

1.7

Method Summary

Modifier and Type	Method and Description
T	compose(double... f) Compute composition of the instance by a univariate function.
int	getFreeParameters() Get the number of free parameters.
int	getOrder() Get the derivation order.
double	getPartialDerivative(int... orders) Get a partial derivative.
double	getValue() Get the value part of the function.

Methods inherited from interface org.hipparchus.CalculusFieldElement

abs, acos, acosh, add, asin, asinh, atan, atan2, atanh, cbrt, ceil, copySign, copySign, cos, cosh, divide, exp, expm1, floor, getExponent, getPi, hypot, isFinite, isInfinite, isNaN, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, log, log10, log1p, multiply, newInstance, norm, pow, pow, pow, reciprocal, remainder, remainder, rint, rootN, round, scalb, sign, sin, sinCos, sinh, sinhCosh, sqrt, subtract, tan, tanh, toDegrees, toRadians, ulp

Methods inherited from interface org.hipparchus.FieldElement

add, divide, getField, getReal, isZero, multiply, multiply, negate, subtract

Method Detail

getFreeParameters

int getFreeParameters()

Get the number of free parameters.

Returns:

number of free parameters

getOrder

int getOrder()

Get the derivation order.

Returns:

derivation order

getValue

double getValue()

Get the value part of the function.

Returns:

value part of the value of the function

getPartialDerivative

double getPartialDerivative(int... orders)
                     throws MathIllegalArgumentException

Get a partial derivative.

Parameters:

orders - derivation orders with respect to each variable (if all orders are 0, the value is returned)

Returns:

partial derivative

Throws:

MathIllegalArgumentException - if the numbers of variables does not match the instance

MathIllegalArgumentException - if sum of derivation orders is larger than the instance limits

See Also:

getValue()

compose

T compose(double... f)
   throws MathIllegalArgumentException

Compute composition of the instance by a univariate function.

Parameters:

f - array of value and derivatives of the function at the current point (i.e. [f(getValue()), f'(getValue()), f''(getValue())...]).

Returns:

f(this)

Throws:

MathIllegalArgumentException - if the number of derivatives in the array is not equal to order + 1