Package org.hipparchus.analysis.differentiation

Class FieldUnivariateDerivative<S extends CalculusFieldElement<S>,T extends FieldUnivariateDerivative<S,T>>

java.lang.Object

org.hipparchus.analysis.differentiation.FieldUnivariateDerivative<S,T>

Type Parameters:

S - the type of the field elements

T - the type of the function derivative

All Implemented Interfaces:

DifferentialAlgebra, FieldDerivative<S,T>, CalculusFieldElement<T>, FieldElement<T>

Direct Known Subclasses:

FieldUnivariateDerivative1, FieldUnivariateDerivative2

public abstract class FieldUnivariateDerivative<S extends CalculusFieldElement<S>,T extends FieldUnivariateDerivative<S,T>>
extends Object
implements FieldDerivative<S,T>

Abstract class representing both the value and the differentials of a function.

Since:

1.7

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldUnivariateDerivative()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
abstract S	getDerivative(int n)	Get a derivative from the univariate derivative.
int	getFreeParameters()	Get the number of free parameters.
S	getPartialDerivative(int... orders)	Get a partial derivative.
abstract FieldDerivativeStructure<S>	toDerivativeStructure()	Convert the instance to a DerivativeStructure.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hipparchus.CalculusFieldElement

abs, acosh, add, asin, asinh, atan, atan2, atanh, cbrt, copySign, copySign, cos, divide, divide, exp, expm1, getAddendum, getPi, hypot, isFinite, isInfinite, isNaN, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, linearCombination, log, log1p, multiply, multiply, newInstance, norm, pow, pow, remainder, remainder, rootN, round, scalb, sin, sinCos, sinhCosh, sqrt, square, subtract, subtract, tan, tanh, toDegrees, toRadians

Methods inherited from interface org.hipparchus.analysis.differentiation.DifferentialAlgebra

getOrder

Methods inherited from interface org.hipparchus.analysis.differentiation.FieldDerivative

acos, add, ceil, cosh, floor, getExponent, getReal, getValue, log10, newInstance, pow, rint, sign, sinh, subtract, ulp, withValue

Methods inherited from interface org.hipparchus.FieldElement

add, getField, isZero, multiply, negate, reciprocal

Constructor Detail

FieldUnivariateDerivative

protected FieldUnivariateDerivative()

Empty constructor.

This constructor is not strictly necessary, but it prevents spurious javadoc warnings with JDK 18 and later.

Since:

3.0

Method Detail

getFreeParameters

public int getFreeParameters()

Get the number of free parameters.

Specified by:

getFreeParameters in interface DifferentialAlgebra

Returns:

number of free parameters

getPartialDerivative

public S getPartialDerivative(int... orders)
                       throws MathIllegalArgumentException

Get a partial derivative.

Specified by:

getPartialDerivative in interface FieldDerivative<S extends CalculusFieldElement<S>,T extends FieldUnivariateDerivative<S,T>>

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

See Also:

FieldDerivative.getValue()

getDerivative

public abstract S getDerivative(int n)
                         throws MathIllegalArgumentException

Get a derivative from the univariate derivative.

Parameters:

n - derivation order (must be between 0 and DifferentialAlgebra.getOrder(), both inclusive)

Returns:

n^th derivative

Throws:

MathIllegalArgumentException - if n is either negative or strictly larger than DifferentialAlgebra.getOrder()

toDerivativeStructure

public abstract FieldDerivativeStructure<S> toDerivativeStructure()

Convert the instance to a DerivativeStructure.

Returns:

derivative structure with same value and derivative as the instance