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 elementsT
- 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
-
Method Summary
Modifier and TypeMethodDescriptionabstract S
getDerivative
(int n) Get a derivative from the univariate derivative.int
Get the number of free parameters.getPartialDerivative
(int... orders) Get a partial derivative.abstract FieldDerivativeStructure<S>
Convert the instance to aDerivativeStructure
.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, 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 Details
-
FieldUnivariateDerivative
public FieldUnivariateDerivative()Empty constructor.This constructor is not strictly necessary, but it prevents spurious javadoc warnings with JDK 18 and later.
- Since:
- 3.0
-
-
Method Details
-
getFreeParameters
public int getFreeParameters()Get the number of free parameters.- Specified by:
getFreeParameters
in interfaceDifferentialAlgebra
- Returns:
- number of free parameters
-
getPartialDerivative
Get a partial derivative.- Specified by:
getPartialDerivative
in interfaceFieldDerivative<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:
-
getDerivative
Get a derivative from the univariate derivative.- Parameters:
n
- derivation order (must be between 0 andDifferentialAlgebra.getOrder()
, both inclusive)- Returns:
- nth derivative
- Throws:
MathIllegalArgumentException
- if n is either negative or strictly larger thanDifferentialAlgebra.getOrder()
-
toDerivativeStructure
Convert the instance to aDerivativeStructure
.- Returns:
- derivative structure with same value and derivative as the instance
-