forked from Hipparchus-Math/hipparchus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Derivative.java
134 lines (115 loc) · 3.87 KB
/
Derivative.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
* Licensed to the Hipparchus project under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The Hipparchus project licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.hipparchus.analysis.differentiation;
import org.hipparchus.CalculusFieldElement;
import org.hipparchus.exception.MathIllegalArgumentException;
import org.hipparchus.util.FastMath;
/** Interface representing both the value and the differentials of a function.
* @param <T> the type of the field elements
* @since 1.7
*/
public interface Derivative<T extends CalculusFieldElement<T>> extends CalculusFieldElement<T> {
/** {@inheritDoc} */
@Override
default double getReal() {
return getValue();
}
/** Get the number of free parameters.
* @return number of free parameters
*/
int getFreeParameters();
/** Get the derivation order.
* @return derivation order
*/
int getOrder();
/** Get the value part of the function.
* @return value part of the value of the function
*/
double getValue();
/** Get a partial derivative.
* @param orders derivation orders with respect to each variable (if all orders are 0,
* the value is returned)
* @return partial derivative
* @see #getValue()
* @exception MathIllegalArgumentException if the numbers of variables does not
* match the instance
* @exception MathIllegalArgumentException if sum of derivation orders is larger
* than the instance limits
*/
double getPartialDerivative(int ... orders)
throws MathIllegalArgumentException;
/** Compute composition of the instance by a univariate function.
* @param f array of value and derivatives of the function at
* the current point (i.e. [f({@link #getValue()}),
* f'({@link #getValue()}), f''({@link #getValue()})...]).
* @return f(this)
* @exception MathIllegalArgumentException if the number of derivatives
* in the array is not equal to {@link #getOrder() order} + 1
*/
T compose(double... f)
throws MathIllegalArgumentException;
/** {@inheritDoc} */
@Override
default T log10() {
return log().divide(FastMath.log(10.));
}
/** {@inheritDoc} */
@Override
default T pow(T e) {
return log().multiply(e).exp();
}
/** {@inheritDoc} */
@Override
default T cosh() {
return (exp().add(negate().exp())).divide(2);
}
/** {@inheritDoc} */
@Override
default T sinh() {
return (exp().subtract(negate().exp())).divide(2);
}
/** {@inheritDoc} */
@Override
default T acos() {
return asin().negate().add(getPi().divide(2));
}
/** {@inheritDoc} */
@Override
default T ceil() {
return newInstance(FastMath.ceil(getValue()));
}
/** {@inheritDoc} */
@Override
default T floor() {
return newInstance(FastMath.floor(getValue()));
}
/** {@inheritDoc} */
@Override
default T rint() {
return newInstance(FastMath.rint(getValue()));
}
/** {@inheritDoc} */
@Override
default T ulp() {
return newInstance(FastMath.ulp(getValue()));
}
/** {@inheritDoc} */
@Override
default T sign() {
return newInstance(FastMath.signum(getValue()));
}
}