forked from Hipparchus-Math/hipparchus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Derivative.java
73 lines (64 loc) · 2.64 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
/*
* 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;
/** 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;
}