Class UnivariateDerivative2
- All Implemented Interfaces:
Serializable,Comparable<UnivariateDerivative2>,Derivative<UnivariateDerivative2>,DifferentialAlgebra,CalculusFieldElement<UnivariateDerivative2>,FieldElement<UnivariateDerivative2>
This class is a stripped-down version of DerivativeStructure
with only one free parameter
and derivation order also limited to two.
It should have less overhead than DerivativeStructure in its domain.
This class is an implementation of Rall's numbers. Rall's numbers are an extension to the real numbers used throughout mathematical expressions; they hold the derivative together with the value of a function.
UnivariateDerivative2 instances can be used directly thanks to
the arithmetic operators to the mathematical functions provided as
methods by this class (+, -, *, /, %, sin, cos ...).
Implementing complex expressions by hand using Derivative-based
classes (or in fact any CalculusFieldElement class) is
a tedious and error-prone task but has the advantage of not requiring users
to compute the derivatives by themselves and allowing to switch for one
derivative implementation to another as they all share the same filed API.
Instances of this class are guaranteed to be immutable.
- Since:
- 1.7
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final UnivariateDerivative2The constant value of π as aUnivariateDerivative2. -
Constructor Summary
ConstructorsConstructorDescriptionUnivariateDerivative2(double f0, double f1, double f2) Build an instance with values and derivative.Build an instance from aDerivativeStructure. -
Method Summary
Modifier and TypeMethodDescriptionabs()absolute value.acos()Arc cosine operation.acosh()Inverse hyperbolic cosine operation.Compute this + a.asin()Arc sine operation.asinh()Inverse hyperbolic sine operation.atan()Arc tangent operation.Two arguments arc tangent operation.atanh()Inverse hyperbolic tangent operation.cbrt()Cubic root.intcompose(double... f) Compute composition of the instance by a univariate function.copySign(double sign) Returns the instance with the sign of the argument.Returns the instance with the sign of the argument.cos()Cosine operation.cosh()Hyperbolic cosine operation.divide(double a) '÷' operator.Compute this ÷ a.booleanTest for the equality of two univariate derivatives.exp()Exponential.expm1()Exponential minus 1.Get the addendum to the real value of the number.doublegetDerivative(int n) Get a derivative from the univariate derivative.getField()Get theFieldto which the instance belongs.doubleGet the first derivative.intgetOrder()Get the maximum derivation order.getPi()Get the Archimedes constant π.doubleGet the second derivative.doublegetValue()Get the value part of the function.inthashCode()Get a hashCode for the univariate derivative.Returns the hypotenuse of a triangle with sidesthisandy- sqrt(this2 +y2) avoiding intermediate overflow or underflow.linearCombination(double[] a, UnivariateDerivative2[] b) Compute a linear combination.linearCombination(double a1, UnivariateDerivative2 b1, double a2, UnivariateDerivative2 b2) Compute a linear combination.linearCombination(double a1, UnivariateDerivative2 b1, double a2, UnivariateDerivative2 b2, double a3, UnivariateDerivative2 b3) Compute a linear combination.linearCombination(double a1, UnivariateDerivative2 b1, double a2, UnivariateDerivative2 b2, double a3, UnivariateDerivative2 b3, double a4, UnivariateDerivative2 b4) Compute a linear combination.Compute a linear combination.linearCombination(UnivariateDerivative2 a1, UnivariateDerivative2 b1, UnivariateDerivative2 a2, UnivariateDerivative2 b2) Compute a linear combination.linearCombination(UnivariateDerivative2 a1, UnivariateDerivative2 b1, UnivariateDerivative2 a2, UnivariateDerivative2 b2, UnivariateDerivative2 a3, UnivariateDerivative2 b3) Compute a linear combination.linearCombination(UnivariateDerivative2 a1, UnivariateDerivative2 b1, UnivariateDerivative2 a2, UnivariateDerivative2 b2, UnivariateDerivative2 a3, UnivariateDerivative2 b3, UnivariateDerivative2 a4, UnivariateDerivative2 b4) Compute a linear combination.log()Natural logarithm.log10()Base 10 logarithm.log1p()Shifted natural logarithm.multiply(double a) '×' operator.multiply(int n) Compute n × this.Compute this × a.negate()Returns the additive inverse ofthiselement.newInstance(double value) Create an instance corresponding to a constant real value.pow(double p) Power operation.static UnivariateDerivative2pow(double a, UnivariateDerivative2 x) Compute ax where a is a double and x aUnivariateDerivative2pow(int n) Integer power operation.Returns the multiplicative inverse ofthiselement.IEEE remainder operator.rootN(int n) Nth root.scalb(int n) Multiply the instance by a power of 2.sin()Sine operation.sinCos()Combined Sine and Cosine operation.sinh()Hyperbolic sine operation.sinhCosh()Combined hyperbolic sine and cosine operation.sqrt()Square root.square()Compute this × this.Compute this - a.tan()Tangent operation.tanh()Hyperbolic tangent operation.doubletaylor(double delta) Evaluate Taylor expansion a univariate derivative.Convert radians to degrees, with error of less than 0.5 ULPConvert the instance to aDerivativeStructure.Convert degrees to radians, with error of less than 0.5 ULPwithValue(double value) Create a new object with new value (zeroth-order derivative, as passed as input) and same derivatives of order one and above.Methods inherited from class org.hipparchus.analysis.differentiation.UnivariateDerivative
getFreeParameters, getPartialDerivativeMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hipparchus.CalculusFieldElement
ceil, floor, isFinite, isInfinite, isNaN, norm, rint, round, sign, ulpMethods inherited from interface org.hipparchus.analysis.differentiation.Derivative
add, getExponent, getReal, pow, remainder, subtractMethods inherited from interface org.hipparchus.FieldElement
isZero
-
Field Details
-
PI
The constant value of π as aUnivariateDerivative2.- Since:
- 2.0
-
-
Constructor Details
-
UnivariateDerivative2
public UnivariateDerivative2(double f0, double f1, double f2) Build an instance with values and derivative.- Parameters:
f0- value of the functionf1- first derivative of the functionf2- second derivative of the function
-
UnivariateDerivative2
Build an instance from aDerivativeStructure.- Parameters:
ds- derivative structure- Throws:
MathIllegalArgumentException- if eitherdsparameters is not 1 ordsorder is not 2
-
-
Method Details
-
newInstance
Create an instance corresponding to a constant real value.- Parameters:
value- constant real value- Returns:
- instance corresponding to a constant real value
-
withValue
Description copied from interface:DerivativeCreate a new object with new value (zeroth-order derivative, as passed as input) and same derivatives of order one and above.This default implementation is there so that no API gets broken by the next release, which is not a major one. Custom inheritors should probably overwrite it.
- Parameters:
value- zeroth-order derivative of new represented function- Returns:
- new object with changed value
-
getAddendum
Get the addendum to the real value of the number.The addendum is considered to be the part that when added back to the
real partrecovers the instance. This means that whene.getReal()is finite (i.e. neither infinite nor NaN), thene.getAddendum().add(e.getReal())iseande.subtract(e.getReal())ise.getAddendum(). Beware that for non-finite numbers, these two equalities may not hold. The first equality (with the addition), always holds even for infinity and NaNs if the real part is independent of the addendum (this is the case for all derivatives types, as well as for complex and Dfp, but it is not the case for Tuple and FieldTuple). The second equality (with the subtraction), generally doesn't hold for non-finite numbers, because the subtraction generates NaNs.- Returns:
- real value
-
getValue
public double getValue()Get the value part of the function.- Returns:
- value part of the value of the function
-
getDerivative
public double getDerivative(int n) Get a derivative from the univariate derivative.- Specified by:
getDerivativein classUnivariateDerivative<UnivariateDerivative2>- Parameters:
n- derivation order (must be between 0 andDifferentialAlgebra.getOrder(), both inclusive)- Returns:
- nth derivative
-
getOrder
public int getOrder()Get the maximum derivation order.- Returns:
- maximum derivation order
-
getFirstDerivative
public double getFirstDerivative()Get the first derivative.- Returns:
- first derivative
- See Also:
-
getSecondDerivative
public double getSecondDerivative()Get the second derivative.- Returns:
- second derivative
- See Also:
-
toDerivativeStructure
Convert the instance to aDerivativeStructure.- Specified by:
toDerivativeStructurein classUnivariateDerivative<UnivariateDerivative2>- Returns:
- derivative structure with same value and derivative as the instance
-
add
Compute this + a.- Parameters:
a- element to add- Returns:
- a new element representing this + a
-
subtract
Compute this - a.- Parameters:
a- element to subtract- Returns:
- a new element representing this - a
-
multiply
Compute n × this. Multiplication by an integer number is defined as the following sum \[ n \times \mathrm{this} = \sum_{i=1}^n \mathrm{this} \]- Parameters:
n- Number of timesthismust be added to itself.- Returns:
- A new element representing n × this.
-
multiply
'×' operator.- Parameters:
a- right hand side parameter of the operator- Returns:
- this×a
-
multiply
Compute this × a.- Parameters:
a- element to multiply- Returns:
- a new element representing this × a
-
square
Compute this × this.- Returns:
- a new element representing this × this
-
divide
'÷' operator.- Parameters:
a- right hand side parameter of the operator- Returns:
- this÷a
-
divide
Compute this ÷ a.- Parameters:
a- element to divide by- Returns:
- a new element representing this ÷ a
-
remainder
IEEE remainder operator.- Parameters:
a- right hand side parameter of the operator- Returns:
- this - n × a where n is the closest integer to this/a
-
negate
Returns the additive inverse ofthiselement.- Returns:
- the opposite of
this.
-
abs
absolute value.- Returns:
- abs(this)
-
copySign
Returns the instance with the sign of the argument. A NaNsignargument is treated as positive.- Parameters:
sign- the sign for the returned value- Returns:
- the instance with the same sign as the
signargument
-
copySign
Returns the instance with the sign of the argument. A NaNsignargument is treated as positive.- Parameters:
sign- the sign for the returned value- Returns:
- the instance with the same sign as the
signargument
-
scalb
Multiply the instance by a power of 2.- Parameters:
n- power of 2- Returns:
- this × 2n
-
hypot
Returns the hypotenuse of a triangle with sidesthisandy- sqrt(this2 +y2) avoiding intermediate overflow or underflow.- If either argument is infinite, then the result is positive infinity.
- else, if either argument is NaN then the result is NaN.
- Parameters:
y- a value- Returns:
- sqrt(this2 +y2)
-
reciprocal
Returns the multiplicative inverse ofthiselement.- Returns:
- the inverse of
this.
-
compose
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(Derivative.getValue()), f'(Derivative.getValue()), f''(Derivative.getValue())...]).- Returns:
- f(this)
-
sqrt
Square root.- Returns:
- square root of the instance
-
cbrt
Cubic root.- Returns:
- cubic root of the instance
-
rootN
Nth root.- Parameters:
n- order of the root- Returns:
- nth root of the instance
-
getField
Get theFieldto which the instance belongs.- Returns:
Fieldto which the instance belongs
-
pow
Compute ax where a is a double and x aUnivariateDerivative2- Parameters:
a- number to exponentiatex- power to apply- Returns:
- ax
-
pow
Power operation.- Parameters:
p- power to apply- Returns:
- thisp
-
pow
Integer power operation.- Parameters:
n- power to apply- Returns:
- thisn
-
exp
Exponential.- Returns:
- exponential of the instance
-
expm1
Exponential minus 1.- Returns:
- exponential minus one of the instance
-
log
Natural logarithm.- Returns:
- logarithm of the instance
-
log1p
Shifted natural logarithm.- Returns:
- logarithm of one plus the instance
-
log10
Base 10 logarithm.- Returns:
- base 10 logarithm of the instance
-
cos
Cosine operation.- Returns:
- cos(this)
-
sin
Sine operation.- Returns:
- sin(this)
-
sinCos
Combined Sine and Cosine operation.- Returns:
- [sin(this), cos(this)]
-
tan
Tangent operation.- Returns:
- tan(this)
-
acos
Arc cosine operation.- Returns:
- acos(this)
-
asin
Arc sine operation.- Returns:
- asin(this)
-
atan
Arc tangent operation.- Returns:
- atan(this)
-
atan2
Two arguments arc tangent operation.Beware of the order or arguments! As this is based on a two-arguments functions, in order to be consistent with arguments order, the instance is the first argument and the single provided argument is the second argument. In order to be consistent with programming languages
atan2, this method computesatan2(this, x), i.e. the instance represents theyargument and thexargument is the one passed as a single argument. This may seem confusing especially for users of Wolfram alpha, as this site is not consistent with programming languagesatan2two-arguments arc tangent and putsxas its first argument.- Parameters:
x- second argument of the arc tangent- Returns:
- atan2(this, x)
-
cosh
Hyperbolic cosine operation.- Returns:
- cosh(this)
-
sinh
Hyperbolic sine operation.- Returns:
- sinh(this)
-
sinhCosh
Combined hyperbolic sine and cosine operation.- Returns:
- [sinh(this), cosh(this)]
-
tanh
Hyperbolic tangent operation.- Returns:
- tanh(this)
-
acosh
Inverse hyperbolic cosine operation.- Returns:
- acosh(this)
-
asinh
Inverse hyperbolic sine operation.- Returns:
- asin(this)
-
atanh
Inverse hyperbolic tangent operation.- Returns:
- atanh(this)
-
toDegrees
Convert radians to degrees, with error of less than 0.5 ULP- Returns:
- instance converted into degrees
-
toRadians
Convert degrees to radians, with error of less than 0.5 ULP- Returns:
- instance converted into radians
-
taylor
public double taylor(double delta) Evaluate Taylor expansion a univariate derivative.- Parameters:
delta- parameter offset Δx- Returns:
- value of the Taylor expansion at x + Δx
-
linearCombination
public UnivariateDerivative2 linearCombination(UnivariateDerivative2[] a, UnivariateDerivative2[] b) Compute a linear combination.- Parameters:
a- Factors.b- Factors.- Returns:
Σi ai bi.
-
linearCombination
Compute a linear combination.- Parameters:
a- Factors.b- Factors.- Returns:
Σi ai bi.
-
linearCombination
public UnivariateDerivative2 linearCombination(UnivariateDerivative2 a1, UnivariateDerivative2 b1, UnivariateDerivative2 a2, UnivariateDerivative2 b2) Compute a linear combination.- Parameters:
a1- first factor of the first termb1- second factor of the first terma2- first factor of the second termb2- second factor of the second term- Returns:
- a1×b1 + a2×b2
- See Also:
-
linearCombination
public UnivariateDerivative2 linearCombination(double a1, UnivariateDerivative2 b1, double a2, UnivariateDerivative2 b2) Compute a linear combination.- Parameters:
a1- first factor of the first termb1- second factor of the first terma2- first factor of the second termb2- second factor of the second term- Returns:
- a1×b1 + a2×b2
- See Also:
-
linearCombination
public UnivariateDerivative2 linearCombination(UnivariateDerivative2 a1, UnivariateDerivative2 b1, UnivariateDerivative2 a2, UnivariateDerivative2 b2, UnivariateDerivative2 a3, UnivariateDerivative2 b3) Compute a linear combination.- Parameters:
a1- first factor of the first termb1- second factor of the first terma2- first factor of the second termb2- second factor of the second terma3- first factor of the third termb3- second factor of the third term- Returns:
- a1×b1 + a2×b2 + a3×b3
- See Also:
-
linearCombination
public UnivariateDerivative2 linearCombination(double a1, UnivariateDerivative2 b1, double a2, UnivariateDerivative2 b2, double a3, UnivariateDerivative2 b3) Compute a linear combination.- Parameters:
a1- first factor of the first termb1- second factor of the first terma2- first factor of the second termb2- second factor of the second terma3- first factor of the third termb3- second factor of the third term- Returns:
- a1×b1 + a2×b2 + a3×b3
- See Also:
-
linearCombination
public UnivariateDerivative2 linearCombination(UnivariateDerivative2 a1, UnivariateDerivative2 b1, UnivariateDerivative2 a2, UnivariateDerivative2 b2, UnivariateDerivative2 a3, UnivariateDerivative2 b3, UnivariateDerivative2 a4, UnivariateDerivative2 b4) Compute a linear combination.- Parameters:
a1- first factor of the first termb1- second factor of the first terma2- first factor of the second termb2- second factor of the second terma3- first factor of the third termb3- second factor of the third terma4- first factor of the fourth termb4- second factor of the fourth term- Returns:
- a1×b1 + a2×b2 + a3×b3 + a4×b4
- See Also:
-
linearCombination
public UnivariateDerivative2 linearCombination(double a1, UnivariateDerivative2 b1, double a2, UnivariateDerivative2 b2, double a3, UnivariateDerivative2 b3, double a4, UnivariateDerivative2 b4) Compute a linear combination.- Parameters:
a1- first factor of the first termb1- second factor of the first terma2- first factor of the second termb2- second factor of the second terma3- first factor of the third termb3- second factor of the third terma4- first factor of the fourth termb4- second factor of the fourth term- Returns:
- a1×b1 + a2×b2 + a3×b3 + a4×b4
- See Also:
-
getPi
Get the Archimedes constant π.Archimedes constant is the ratio of a circle's circumference to its diameter.
- Returns:
- Archimedes constant π
-
equals
Test for the equality of two univariate derivatives.univariate derivatives are considered equal if they have the same derivatives.
-
hashCode
public int hashCode()Get a hashCode for the univariate derivative. -
compareTo
Comparison performed considering that derivatives are intrinsically linked to monomials in the corresponding Taylor expansion and that the higher the degree, the smaller the term.
- Since:
- 3.0
-