forked from Hipparchus-Math/hipparchus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
DerivativeStructure.java
1192 lines (1043 loc) · 41.9 KB
/
DerivativeStructure.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.
*/
/*
* This is not the original file distributed by the Apache Software Foundation
* It has been modified by the Hipparchus project
*/
package org.hipparchus.analysis.differentiation;
import java.io.Serializable;
import org.hipparchus.Field;
import org.hipparchus.exception.MathIllegalArgumentException;
import org.hipparchus.exception.MathRuntimeException;
import org.hipparchus.util.FastMath;
import org.hipparchus.util.FieldSinCos;
import org.hipparchus.util.FieldSinhCosh;
import org.hipparchus.util.MathArrays;
import org.hipparchus.util.MathUtils;
/** Class representing both the value and the differentials of a function.
* <p>This class is the workhorse of the differentiation package.</p>
* <p>This class is an implementation of the extension to Rall's
* numbers described in Dan Kalman's paper <a
* href="http://www.dankalman.net/AUhome/pdffiles/mmgautodiff.pdf">Doubly
* Recursive Multivariate Automatic Differentiation</a>, Mathematics Magazine, vol. 75,
* no. 3, June 2002. 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. Dan Kalman's derivative structures hold all partial derivatives
* up to any specified order, with respect to any number of free parameters. Rall's
* numbers therefore can be seen as derivative structures for order one derivative and
* one free parameter, and real numbers can be seen as derivative structures with zero
* order derivative and no free parameters.</p>
* <p>{@link DerivativeStructure} instances can be used directly thanks to
* the arithmetic operators to the mathematical functions provided as
* methods by this class (+, -, *, /, %, sin, cos ...).</p>
* <p>Implementing complex expressions by hand using these classes is
* a tedious and error-prone task but has the advantage of having no limitation
* on the derivation order despite not requiring users to compute the derivatives by
* themselves. Implementing complex expression can also be done by developing computation
* code using standard primitive double values and to use {@link
* UnivariateFunctionDifferentiator differentiators} to create the {@link
* DerivativeStructure}-based instances. This method is simpler but may be limited in
* the accuracy and derivation orders and may be computationally intensive (this is
* typically the case for {@link FiniteDifferencesDifferentiator finite differences
* differentiator}.</p>
* <p>Instances of this class are guaranteed to be immutable.</p>
* @see DSCompiler
* @see FieldDerivativeStructure
*/
public class DerivativeStructure implements Derivative<DerivativeStructure>, Serializable {
/** Serializable UID. */
private static final long serialVersionUID = 20161220L;
/** Factory that built the instance. */
private final DSFactory factory;
/** Combined array holding all values. */
private final double[] data;
/** Build an instance with all values and derivatives set to 0.
* @param factory factory that built the instance
* @param data combined array holding all values
*/
DerivativeStructure(final DSFactory factory, final double[] data) {
this.factory = factory;
this.data = data.clone();
}
/** Build an instance with all values and derivatives set to 0.
* @param factory factory that built the instance
* @since 1.4
*/
DerivativeStructure(final DSFactory factory) {
this.factory = factory;
this.data = new double[factory.getCompiler().getSize()];
}
/** {@inheritDoc} */
@Override
public DerivativeStructure newInstance(final double value) {
return factory.constant(value);
}
/** Get the factory that built the instance.
* @return factory that built the instance
*/
public DSFactory getFactory() {
return factory;
}
@Override
/** {@inheritDoc} */
public int getFreeParameters() {
return getFactory().getCompiler().getFreeParameters();
}
@Override
/** {@inheritDoc} */
public int getOrder() {
return getFactory().getCompiler().getOrder();
}
/** Set a derivative component.
* <p>
* This method is package-private (no modifier specified), as it is intended
* to be used only by Hipparchus classes since it relied on the ordering of
* derivatives within the class. This allows avoiding checks on the index,
* for performance reasons.
* </p>
* @param index index of the derivative
* @param value of the derivative to set
* @since 1.4
*/
void setDerivativeComponent(final int index, final double value) {
data[index] = value;
}
/** Get a derivative component.
* <p>
* This method is package-private (no modifier specified), as it is intended
* to be used only by Hipparchus classes since it relied on the ordering of
* derivatives within the class. This allows avoiding checks on the index,
* for performance reasons.
* </p>
* @param index index of the derivative
* @return value of the derivative
* @since 2.2
*/
double getDerivativeComponent(final int index) {
return data[index];
}
/** Get the value part of the derivative structure.
* @return value part of the derivative structure
* @see #getPartialDerivative(int...)
*/
@Override
public double getValue() {
return data[0];
}
/** {@inheritDoc} */
@Override
public double getPartialDerivative(final int ... orders)
throws MathIllegalArgumentException {
return data[getFactory().getCompiler().getPartialDerivativeIndex(orders)];
}
/** Get all partial derivatives.
* @return a fresh copy of partial derivatives, in an array sorted according to
* {@link DSCompiler#getPartialDerivativeIndex(int...)}
*/
public double[] getAllDerivatives() {
return data.clone();
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure add(final double a) {
final DerivativeStructure ds = factory.build();
System.arraycopy(data, 0, ds.data, 0, data.length);
ds.data[0] += a;
return ds;
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure add(final DerivativeStructure a)
throws MathIllegalArgumentException {
factory.checkCompatibility(a.factory);
final DerivativeStructure ds = factory.build();
factory.getCompiler().add(data, 0, a.data, 0, ds.data, 0);
return ds;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure subtract(final double a) {
return add(-a);
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure subtract(final DerivativeStructure a)
throws MathIllegalArgumentException {
factory.checkCompatibility(a.factory);
final DerivativeStructure ds = factory.build();
factory.getCompiler().subtract(data, 0, a.data, 0, ds.data, 0);
return ds;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure multiply(final double a) {
final DerivativeStructure ds = factory.build();
for (int i = 0; i < ds.data.length; ++i) {
ds.data[i] = data[i] * a;
}
return ds;
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure multiply(final DerivativeStructure a)
throws MathIllegalArgumentException {
factory.checkCompatibility(a.factory);
final DerivativeStructure result = factory.build();
factory.getCompiler().multiply(data, 0, a.data, 0, result.data, 0);
return result;
}
/** {@inheritDoc} */
@Override
public DerivativeStructure square() {
return multiply(this);
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure divide(final double a) {
final DerivativeStructure ds = factory.build();
final double inv = 1.0 / a;
for (int i = 0; i < ds.data.length; ++i) {
ds.data[i] = data[i] * inv;
}
return ds;
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure divide(final DerivativeStructure a)
throws MathIllegalArgumentException {
factory.checkCompatibility(a.factory);
final DerivativeStructure result = factory.build();
factory.getCompiler().divide(data, 0, a.data, 0, result.data, 0);
return result;
}
/** {@inheritDoc} */
@Override
public DerivativeStructure remainder(final double a) {
final DerivativeStructure ds = factory.build();
System.arraycopy(data, 0, ds.data, 0, data.length);
ds.data[0] = FastMath.IEEEremainder(ds.data[0], a);
return ds;
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure remainder(final DerivativeStructure a)
throws MathIllegalArgumentException {
factory.checkCompatibility(a.factory);
final DerivativeStructure result = factory.build();
factory.getCompiler().remainder(data, 0, a.data, 0, result.data, 0);
return result;
}
/** {@inheritDoc} */
@Override
public DerivativeStructure negate() {
final DerivativeStructure ds = factory.build();
for (int i = 0; i < ds.data.length; ++i) {
ds.data[i] = -data[i];
}
return ds;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure abs() {
if (Double.doubleToLongBits(data[0]) < 0) {
// we use the bits representation to also handle -0.0
return negate();
} else {
return this;
}
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure ceil() {
return factory.constant(FastMath.ceil(data[0]));
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure floor() {
return factory.constant(FastMath.floor(data[0]));
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure rint() {
return factory.constant(FastMath.rint(data[0]));
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure sign() {
return factory.constant(FastMath.signum(data[0]));
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure copySign(final DerivativeStructure sign) {
long m = Double.doubleToLongBits(data[0]);
long s = Double.doubleToLongBits(sign.data[0]);
if ((m >= 0 && s >= 0) || (m < 0 && s < 0)) { // Sign is currently OK
return this;
}
return negate(); // flip sign
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure copySign(final double sign) {
long m = Double.doubleToLongBits(data[0]);
long s = Double.doubleToLongBits(sign);
if ((m >= 0 && s >= 0) || (m < 0 && s < 0)) { // Sign is currently OK
return this;
}
return negate(); // flip sign
}
/**
* Return the exponent of the instance value, removing the bias.
* <p>
* For double numbers of the form 2<sup>x</sup>, the unbiased
* exponent is exactly x.
* </p>
* @return exponent for instance in IEEE754 representation, without bias
*/
@Override
public int getExponent() {
return FastMath.getExponent(data[0]);
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure scalb(final int n) {
final DerivativeStructure ds = factory.build();
for (int i = 0; i < ds.data.length; ++i) {
ds.data[i] = FastMath.scalb(data[i], n);
}
return ds;
}
/** {@inheritDoc}
* <p>
* The {@code ulp} function is a step function, hence all its derivatives are 0.
* </p>
* @since 2.0
*/
@Override
public DerivativeStructure ulp() {
final DerivativeStructure ds = factory.build();
ds.data[0] = FastMath.ulp(data[0]);
return ds;
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure hypot(final DerivativeStructure y)
throws MathIllegalArgumentException {
factory.checkCompatibility(y.factory);
if (Double.isInfinite(data[0]) || Double.isInfinite(y.data[0])) {
return factory.constant(Double.POSITIVE_INFINITY);
} else if (Double.isNaN(data[0]) || Double.isNaN(y.data[0])) {
return factory.constant(Double.NaN);
} else {
final int expX = getExponent();
final int expY = y.getExponent();
if (expX > expY + 27) {
// y is neglectible with respect to x
return abs();
} else if (expY > expX + 27) {
// x is neglectible with respect to y
return y.abs();
} else {
// find an intermediate scale to avoid both overflow and underflow
final int middleExp = (expX + expY) / 2;
// scale parameters without losing precision
final DerivativeStructure scaledX = scalb(-middleExp);
final DerivativeStructure scaledY = y.scalb(-middleExp);
// compute scaled hypotenuse
final DerivativeStructure scaledH =
scaledX.multiply(scaledX).add(scaledY.multiply(scaledY)).sqrt();
// remove scaling
return scaledH.scalb(middleExp);
}
}
}
/**
* Returns the hypotenuse of a triangle with sides {@code x} and {@code y}
* - sqrt(<i>x</i><sup>2</sup> +<i>y</i><sup>2</sup>)
* avoiding intermediate overflow or underflow.
*
* <ul>
* <li> If either argument is infinite, then the result is positive infinity.</li>
* <li> else, if either argument is NaN then the result is NaN.</li>
* </ul>
*
* @param x a value
* @param y a value
* @return sqrt(<i>x</i><sup>2</sup> +<i>y</i><sup>2</sup>)
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
public static DerivativeStructure hypot(final DerivativeStructure x, final DerivativeStructure y)
throws MathIllegalArgumentException {
return x.hypot(y);
}
/** 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
*/
@Override
public DerivativeStructure compose(final double ... f)
throws MathIllegalArgumentException {
MathUtils.checkDimension(f.length, getOrder() + 1);
final DerivativeStructure result = factory.build();
factory.getCompiler().compose(data, 0, f, result.data, 0);
return result;
}
/** {@inheritDoc} */
@Override
public DerivativeStructure reciprocal() {
final DerivativeStructure result = factory.build();
factory.getCompiler().reciprocal(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure sqrt() {
final DerivativeStructure result = factory.build();
factory.getCompiler().sqrt(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure rootN(final int n) {
final DerivativeStructure result = factory.build();
factory.getCompiler().rootN(data, 0, n, result.data, 0);
return result;
}
/** {@inheritDoc} */
@Override
public Field<DerivativeStructure> getField() {
return factory.getDerivativeField();
}
/** Compute a<sup>x</sup> where a is a double and x a {@link DerivativeStructure}
* @param a number to exponentiate
* @param x power to apply
* @return a<sup>x</sup>
*/
public static DerivativeStructure pow(final double a, final DerivativeStructure x) {
final DerivativeStructure result = x.factory.build();
x.factory.getCompiler().pow(a, x.data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure pow(final double p) {
final DerivativeStructure result = factory.build();
factory.getCompiler().pow(data, 0, p, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure pow(final int n) {
final DerivativeStructure result = factory.build();
factory.getCompiler().pow(data, 0, n, result.data, 0);
return result;
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure pow(final DerivativeStructure e)
throws MathIllegalArgumentException {
factory.checkCompatibility(e.factory);
final DerivativeStructure result = factory.build();
factory.getCompiler().pow(data, 0, e.data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure exp() {
final DerivativeStructure result = factory.build();
factory.getCompiler().exp(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure expm1() {
final DerivativeStructure result = factory.build();
factory.getCompiler().expm1(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure log() {
final DerivativeStructure result = factory.build();
factory.getCompiler().log(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure log1p() {
final DerivativeStructure result = factory.build();
factory.getCompiler().log1p(data, 0, result.data, 0);
return result;
}
/** Base 10 logarithm.
* @return base 10 logarithm of the instance
*/
@Override
public DerivativeStructure log10() {
final DerivativeStructure result = factory.build();
factory.getCompiler().log10(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure cos() {
final DerivativeStructure result = factory.build();
factory.getCompiler().cos(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure sin() {
final DerivativeStructure result = factory.build();
factory.getCompiler().sin(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public FieldSinCos<DerivativeStructure> sinCos() {
final DerivativeStructure sin = factory.build();
final DerivativeStructure cos = factory.build();
factory.getCompiler().sinCos(data, 0, sin.data, 0, cos.data, 0);
return new FieldSinCos<>(sin, cos);
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure tan() {
final DerivativeStructure result = factory.build();
factory.getCompiler().tan(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure acos() {
final DerivativeStructure result = factory.build();
factory.getCompiler().acos(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure asin() {
final DerivativeStructure result = factory.build();
factory.getCompiler().asin(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure atan() {
final DerivativeStructure result = factory.build();
factory.getCompiler().atan(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure atan2(final DerivativeStructure x)
throws MathIllegalArgumentException {
factory.checkCompatibility(x.factory);
final DerivativeStructure result = factory.build();
factory.getCompiler().atan2(data, 0, x.data, 0, result.data, 0);
return result;
}
/** Two arguments arc tangent operation.
* @param y first argument of the arc tangent
* @param x second argument of the arc tangent
* @return atan2(y, x)
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
public static DerivativeStructure atan2(final DerivativeStructure y, final DerivativeStructure x)
throws MathIllegalArgumentException {
return y.atan2(x);
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure cosh() {
final DerivativeStructure result = factory.build();
factory.getCompiler().cosh(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure sinh() {
final DerivativeStructure result = factory.build();
factory.getCompiler().sinh(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public FieldSinhCosh<DerivativeStructure> sinhCosh() {
final DerivativeStructure sinh = factory.build();
final DerivativeStructure cosh = factory.build();
factory.getCompiler().sinhCosh(data, 0, sinh.data, 0, cosh.data, 0);
return new FieldSinhCosh<>(sinh, cosh);
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure tanh() {
final DerivativeStructure result = factory.build();
factory.getCompiler().tanh(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure acosh() {
final DerivativeStructure result = factory.build();
factory.getCompiler().acosh(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure asinh() {
final DerivativeStructure result = factory.build();
factory.getCompiler().asinh(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc}
*/
@Override
public DerivativeStructure atanh() {
final DerivativeStructure result = factory.build();
factory.getCompiler().atanh(data, 0, result.data, 0);
return result;
}
/** {@inheritDoc} */
@Override
public DerivativeStructure toDegrees() {
final DerivativeStructure ds = factory.build();
for (int i = 0; i < ds.data.length; ++i) {
ds.data[i] = FastMath.toDegrees(data[i]);
}
return ds;
}
/** {@inheritDoc} */
@Override
public DerivativeStructure toRadians() {
final DerivativeStructure ds = factory.build();
for (int i = 0; i < ds.data.length; ++i) {
ds.data[i] = FastMath.toRadians(data[i]);
}
return ds;
}
/** Integrate w.r.t. one independent variable.
* <p>
* Rigorously, if the derivatives of a function are known up to
* order N, the ones of its M-th integral w.r.t. a given variable
* (seen as a function itself) are actually known up to order N+M.
* However, this method still casts the output as a DerivativeStructure
* of order N. The integration constants are systematically set to zero.
* </p>
* @param varIndex Index of independent variable w.r.t. which integration is done.
* @param integrationOrder Number of times the integration operator must be applied. If non-positive, call the
* differentiation operator.
* @return DerivativeStructure on which integration operator has been applied a certain number of times.
* @since 2.2
*/
public DerivativeStructure integrate(final int varIndex, final int integrationOrder) {
// Deal first with trivial case
if (integrationOrder > getOrder()) {
return factory.constant(0.);
} else if (integrationOrder == 0) {
return factory.build(data);
}
// Call 'inverse' (not rigorously) operation if necessary
if (integrationOrder < 0) {
return differentiate(varIndex, -integrationOrder);
}
final double[] newData = new double[data.length];
final DSCompiler dsCompiler = factory.getCompiler();
for (int i = 0; i < newData.length; i++) {
if (data[i] != 0.) {
final int[] orders = dsCompiler.getPartialDerivativeOrders(i);
int sum = 0;
for (int order : orders) {
sum += order;
}
if (sum + integrationOrder <= getOrder()) {
final int saved = orders[varIndex];
orders[varIndex] += integrationOrder;
final int index = dsCompiler.getPartialDerivativeIndex(orders);
orders[varIndex] = saved;
newData[index] = data[i];
}
}
}
return factory.build(newData);
}
/** Differentiate w.r.t. one independent variable.
* <p>
* Rigorously, if the derivatives of a function are known up to
* order N, the ones of its M-th derivative w.r.t. a given variable
* (seen as a function itself) are only known up to order N-M.
* However, this method still casts the output as a DerivativeStructure
* of order N with zeroes for the higher order terms.
* </p>
* @param varIndex Index of independent variable w.r.t. which differentiation is done.
* @param differentiationOrder Number of times the differentiation operator must be applied. If non-positive, call
* the integration operator instead.
* @return DerivativeStructure on which differentiation operator has been applied a certain number of times
* @since 2.2
*/
public DerivativeStructure differentiate(final int varIndex, final int differentiationOrder) {
// Deal first with trivial case
if (differentiationOrder > getOrder()) {
return factory.constant(0.);
} else if (differentiationOrder == 0) {
return factory.build(data);
}
// Call 'inverse' (not rigorously) operation if necessary
if (differentiationOrder < 0) {
return integrate(varIndex, -differentiationOrder);
}
final double[] newData = new double[data.length];
final DSCompiler dsCompiler = factory.getCompiler();
for (int i = 0; i < newData.length; i++) {
if (data[i] != 0.) {
final int[] orders = dsCompiler.getPartialDerivativeOrders(i);
if (orders[varIndex] - differentiationOrder >= 0) {
final int saved = orders[varIndex];
orders[varIndex] -= differentiationOrder;
final int index = dsCompiler.getPartialDerivativeIndex(orders);
orders[varIndex] = saved;
newData[index] = data[i];
}
}
}
return factory.build(newData);
}
/** Evaluate Taylor expansion a derivative structure.
* @param delta parameters offsets (Δx, Δy, ...)
* @return value of the Taylor expansion at x + Δx, y + Δy, ...
* @throws MathRuntimeException if factorials becomes too large
*/
public double taylor(final double ... delta) throws MathRuntimeException {
return factory.getCompiler().taylor(data, 0, delta);
}
/** Rebase instance with respect to low level parameter functions.
* <p>
* The instance is considered to be a function of {@link #getFreeParameters()
* n free parameters} up to order {@link #getOrder() o} \(f(p_0, p_1, \ldots p_{n-1})\).
* Its {@link #getPartialDerivative(int...) partial derivatives} are therefore
* \(f, \frac{\partial f}{\partial p_0}, \frac{\partial f}{\partial p_1}, \ldots
* \frac{\partial^2 f}{\partial p_0^2}, \frac{\partial^2 f}{\partial p_0 p_1},
* \ldots \frac{\partial^o f}{\partial p_{n-1}^o}\). The free parameters
* \(p_0, p_1, \ldots p_{n-1}\) are considered to be functions of \(m\) lower
* level other parameters \(q_0, q_1, \ldots q_{m-1}\).
* </p>
* \( \begin{align}
* p_0 & = p_0(q_0, q_1, \ldots q_{m-1})\\
* p_1 & = p_1(q_0, q_1, \ldots q_{m-1})\\
* p_{n-1} & = p_{n-1}(q_0, q_1, \ldots q_{m-1})
* \end{align}\)
* <p>
* This method compute the composition of the partial derivatives of \(f\)
* and the partial derivatives of \(p_0, p_1, \ldots p_{n-1}\), i.e. the
* {@link #getPartialDerivative(int...) partial derivatives} of the value
* returned will be
* \(f, \frac{\partial f}{\partial q_0}, \frac{\partial f}{\partial q_1}, \ldots
* \frac{\partial^2 f}{\partial q_0^2}, \frac{\partial^2 f}{\partial q_0 q_1},
* \ldots \frac{\partial^o f}{\partial q_{m-1}^o}\).
* </p>
* <p>
* The number of parameters must match {@link #getFreeParameters()} and the
* derivation orders of the instance and parameters must also match.
* </p>
* @param p base parameters with respect to which partial derivatives
* were computed in the instance
* @return derivative structure with partial derivatives computed
* with respect to the lower level parameters used in the \(p_i\)
* @since 2.2
*/
public DerivativeStructure rebase(final DerivativeStructure... p) {
MathUtils.checkDimension(getFreeParameters(), p.length);
// handle special case of no variables at all
if (p.length == 0) {
return this;
}
final int pSize = p[0].getFactory().getCompiler().getSize();
final double[] pData = new double[p.length * pSize];
for (int i = 0; i < p.length; ++i) {
MathUtils.checkDimension(getOrder(), p[i].getOrder());
MathUtils.checkDimension(p[0].getFreeParameters(), p[i].getFreeParameters());
System.arraycopy(p[i].data, 0, pData, i * pSize, pSize);
}
final DerivativeStructure result = p[0].factory.build();
factory.getCompiler().rebase(data, 0, p[0].factory.getCompiler(), pData, result.data, 0);
return result;
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure linearCombination(final DerivativeStructure[] a, final DerivativeStructure[] b)
throws MathIllegalArgumentException {
// compute an accurate value, taking care of cancellations
final double[] aDouble = new double[a.length];
for (int i = 0; i < a.length; ++i) {
aDouble[i] = a[i].getValue();
}
final double[] bDouble = new double[b.length];
for (int i = 0; i < b.length; ++i) {
bDouble[i] = b[i].getValue();
}
final double accurateValue = MathArrays.linearCombination(aDouble, bDouble);
// compute a simple value, with all partial derivatives
DerivativeStructure simpleValue = a[0].getField().getZero();
for (int i = 0; i < a.length; ++i) {
simpleValue = simpleValue.add(a[i].multiply(b[i]));
}
// create a result with accurate value and all derivatives (not necessarily as accurate as the value)
final double[] all = simpleValue.getAllDerivatives();
all[0] = accurateValue;
return factory.build(all);
}
/** {@inheritDoc}
* @exception MathIllegalArgumentException if number of free parameters
* or orders do not match
*/
@Override
public DerivativeStructure linearCombination(final double[] a, final DerivativeStructure[] b)
throws MathIllegalArgumentException {
// compute an accurate value, taking care of cancellations
final double[] bDouble = new double[b.length];
for (int i = 0; i < b.length; ++i) {
bDouble[i] = b[i].getValue();
}
final double accurateValue = MathArrays.linearCombination(a, bDouble);
// compute a simple value, with all partial derivatives
DerivativeStructure simpleValue = b[0].getField().getZero();
for (int i = 0; i < a.length; ++i) {
simpleValue = simpleValue.add(b[i].multiply(a[i]));
}
// create a result with accurate value and all derivatives (not necessarily as accurate as the value)
final double[] all = simpleValue.getAllDerivatives();
all[0] = accurateValue;
return factory.build(all);
}