forked from Hipparchus-Math/hipparchus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Gradient.java
948 lines (835 loc) · 31 KB
/
Gradient.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
/*
* 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 java.io.Serializable;
import java.util.Arrays;
import org.hipparchus.exception.LocalizedCoreFormats;
import org.hipparchus.exception.MathIllegalArgumentException;
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;
import org.hipparchus.util.SinCos;
import org.hipparchus.util.SinhCosh;
/** Class representing both the value and the differentials of a function.
* <p>This class is a stripped-down version of {@link DerivativeStructure}
* with {@link DerivativeStructure#getOrder() derivation order} limited to one.
* It should have less overhead than {@link DerivativeStructure} in its domain.</p>
* <p>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.</p>
* <p>{@link Gradient} 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.</p>
* <p>Instances of this class are guaranteed to be immutable.</p>
* @see DerivativeStructure
* @see UnivariateDerivative1
* @see UnivariateDerivative2
* @see FieldDerivativeStructure
* @see FieldUnivariateDerivative1
* @see FieldUnivariateDerivative2
* @see FieldGradient
* @since 1.7
*/
public class Gradient implements Derivative<Gradient>, Serializable {
/** Serializable UID. */
private static final long serialVersionUID = 20200520L;
/** Value of the function. */
private final double value;
/** Gradient of the function. */
private final double[] grad;
/** Build an instance with values and unitialized derivatives array.
* @param value value of the function
* @param freeParameters number of free parameters
*/
private Gradient(final double value, int freeParameters) {
this.value = value;
this.grad = new double[freeParameters];
}
/** Build an instance with values and derivative.
* @param value value of the function
* @param gradient gradient of the function
*/
public Gradient(final double value, final double... gradient) {
this(value, gradient.length);
System.arraycopy(gradient, 0, grad, 0, grad.length);
}
/** Build an instance from a {@link DerivativeStructure}.
* @param ds derivative structure
* @exception MathIllegalArgumentException if {@code ds} order
* is not 1
*/
public Gradient(final DerivativeStructure ds) throws MathIllegalArgumentException {
this(ds.getValue(), ds.getFreeParameters());
MathUtils.checkDimension(ds.getOrder(), 1);
System.arraycopy(ds.getAllDerivatives(), 1, grad, 0, grad.length);
}
/** Build an instance corresponding to a constant value.
* @param freeParameters number of free parameters (i.e. dimension of the gradient)
* @param value constant value of the function
* @return a {@code Gradient} with a constant value and all derivatives set to 0.0
*/
public static Gradient constant(final int freeParameters, final double value) {
return new Gradient(value, freeParameters);
}
/** Build a {@code Gradient} representing a variable.
* <p>Instances built using this method are considered
* to be the free variables with respect to which differentials
* are computed. As such, their differential with respect to
* themselves is +1.</p>
* @param freeParameters number of free parameters (i.e. dimension of the gradient)
* @param index index of the variable (from 0 to {@link #getFreeParameters() getFreeParameters()} - 1)
* @param value value of the variable
* @return a {@code Gradient} with a constant value and all derivatives set to 0.0 except the
* one at {@code index} which will be set to 1.0
*/
public static Gradient variable(final int freeParameters, final int index, final double value) {
final Gradient g = new Gradient(value, freeParameters);
g.grad[index] = 1.0;
return g;
}
/** {@inheritDoc} */
@Override
public Gradient newInstance(final double c) {
return new Gradient(c, new double[grad.length]);
}
/** Get the value part of the function.
* @return value part of the value of the function
*/
@Override
public double getValue() {
return value;
}
/** Get the gradient part of the function.
* @return gradient part of the value of the function
* @see #getPartialDerivative(int)
*/
public double[] getGradient() {
return grad.clone();
}
/** {@inheritDoc} */
@Override
public int getFreeParameters() {
return grad.length;
}
/** {@inheritDoc} */
@Override
public int getOrder() {
return 1;
}
/** {@inheritDoc} */
@Override
public double getPartialDerivative(final int ... orders)
throws MathIllegalArgumentException {
// check the number of components
if (orders.length != grad.length) {
throw new MathIllegalArgumentException(LocalizedCoreFormats.DIMENSIONS_MISMATCH,
orders.length, grad.length);
}
// check that either all derivation orders are set to 0,
// or that only one is set to 1 and all other ones are set to 0
int selected = -1;
for (int i = 0; i < orders.length; ++i) {
if (orders[i] != 0) {
if (selected >= 0 || orders[i] != 1) {
throw new MathIllegalArgumentException(LocalizedCoreFormats.DERIVATION_ORDER_NOT_ALLOWED,
orders[i]);
}
// found the component set to derivation order 1
selected = i;
}
}
return (selected < 0) ? value : grad[selected];
}
/** Get the partial derivative with respect to one parameter.
* @param n index of the parameter (counting from 0)
* @return partial derivative with respect to the n<sup>th</sup> parameter
* @exception MathIllegalArgumentException if n is either negative or larger
* or equal to {@link #getFreeParameters()}
*/
public double getPartialDerivative(final int n) throws MathIllegalArgumentException {
if (n < 0 || n >= grad.length) {
throw new MathIllegalArgumentException(LocalizedCoreFormats.OUT_OF_RANGE_SIMPLE, n, 0, grad.length - 1);
}
return grad[n];
}
/** Convert the instance to a {@link DerivativeStructure}.
* @return derivative structure with same value and derivative as the instance
*/
public DerivativeStructure toDerivativeStructure() {
final double[] derivatives = new double[1 + grad.length];
derivatives[0] = value;
System.arraycopy(grad, 0, derivatives, 1, grad.length);
return getField().getConversionFactory().build(derivatives);
}
/** {@inheritDoc} */
@Override
public Gradient add(final double a) {
return new Gradient(value + a, grad);
}
/** {@inheritDoc} */
@Override
public Gradient add(final Gradient a) {
final Gradient result = newInstance(value + a.value);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = grad[i] + a.grad[i];
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient subtract(final double a) {
return new Gradient(value - a, grad);
}
/** {@inheritDoc} */
@Override
public Gradient subtract(final Gradient a) {
final Gradient result = newInstance(value - a.value);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = grad[i] - a.grad[i];
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient multiply(final int n) {
final Gradient result = newInstance(value * n);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = grad[i] * n;
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient multiply(final double a) {
final Gradient result = newInstance(value * a);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = grad[i] * a;
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient multiply(final Gradient a) {
final Gradient result = newInstance(value * a.value);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = grad[i] * a.value + value * a.grad[i];
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient square() {
final Gradient result = newInstance(value * value);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = 2 * grad[i] * value;
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient divide(final double a) {
final Gradient result = newInstance(value / a);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = grad[i] / a;
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient divide(final Gradient a) {
final double inv1 = 1.0 / a.value;
final double inv2 = inv1 * inv1;
final Gradient result = newInstance(value * inv1);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = (grad[i] * a.value - value * a.grad[i]) * inv2;
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient remainder(final double a) {
return new Gradient(FastMath.IEEEremainder(value, a), grad);
}
/** {@inheritDoc} */
@Override
public Gradient remainder(final Gradient a) {
// compute k such that lhs % rhs = lhs - k rhs
final double rem = FastMath.IEEEremainder(value, a.value);
final double k = FastMath.rint((value - rem) / a.value);
final Gradient result = newInstance(rem);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = grad[i] - k * a.grad[i];
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient negate() {
final Gradient result = newInstance(-value);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = -grad[i];
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient abs() {
if (Double.doubleToLongBits(value) < 0) {
// we use the bits representation to also handle -0.0
return negate();
} else {
return this;
}
}
/** {@inheritDoc} */
@Override
public Gradient ceil() {
return newInstance(FastMath.ceil(value));
}
/** {@inheritDoc} */
@Override
public Gradient floor() {
return newInstance(FastMath.floor(value));
}
/** {@inheritDoc} */
@Override
public Gradient rint() {
return newInstance(FastMath.rint(value));
}
/** {@inheritDoc} */
@Override
public Gradient sign() {
return newInstance(FastMath.signum(value));
}
/** {@inheritDoc} */
@Override
public Gradient copySign(final Gradient sign) {
long m = Double.doubleToLongBits(value);
long s = Double.doubleToLongBits(sign.value);
if ((m >= 0 && s >= 0) || (m < 0 && s < 0)) { // Sign is currently OK
return this;
}
return negate(); // flip sign
}
/** {@inheritDoc} */
@Override
public Gradient copySign(final double sign) {
long m = Double.doubleToLongBits(value);
long s = Double.doubleToLongBits(sign);
if ((m >= 0 && s >= 0) || (m < 0 && s < 0)) { // Sign is currently OK
return this;
}
return negate(); // flip sign
}
/** {@inheritDoc} */
@Override
public int getExponent() {
return FastMath.getExponent(value);
}
/** {@inheritDoc} */
@Override
public Gradient scalb(final int n) {
final Gradient result = newInstance(FastMath.scalb(value, n));
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = FastMath.scalb(grad[i], n);
}
return result;
}
/** {@inheritDoc}
* <p>
* The {@code ulp} function is a step function, hence all its derivatives are 0.
* </p>
* @since 2.0
*/
@Override
public Gradient ulp() {
return newInstance(FastMath.ulp(value));
}
/** {@inheritDoc} */
@Override
public Gradient hypot(final Gradient y) {
if (Double.isInfinite(value) || Double.isInfinite(y.value)) {
return newInstance(Double.POSITIVE_INFINITY);
} else if (Double.isNaN(value) || Double.isNaN(y.value)) {
return newInstance(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 Gradient scaledX = scalb(-middleExp);
final Gradient scaledY = y.scalb(-middleExp);
// compute scaled hypotenuse
final Gradient scaledH =
scaledX.multiply(scaledX).add(scaledY.multiply(scaledY)).sqrt();
// remove scaling
return scaledH.scalb(middleExp);
}
}
}
/** {@inheritDoc} */
@Override
public Gradient reciprocal() {
final double inv1 = 1.0 / value;
final double inv2 = inv1 * inv1;
final Gradient result = newInstance(inv1);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = -grad[i] * inv2;
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient compose(final double... f) {
MathUtils.checkDimension(f.length, getOrder() + 1);
final Gradient result = newInstance(f[0]);
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = f[1] * grad[i];
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient sqrt() {
final double s = FastMath.sqrt(value);
return compose(s, 1 / (2 * s));
}
/** {@inheritDoc} */
@Override
public Gradient cbrt() {
final double c = FastMath.cbrt(value);
return compose(c, 1 / (3 * c * c));
}
/** {@inheritDoc} */
@Override
public Gradient rootN(final int n) {
if (n == 2) {
return sqrt();
} else if (n == 3) {
return cbrt();
} else {
final double r = FastMath.pow(value, 1.0 / n);
return compose(r, 1 / (n * FastMath.pow(r, n - 1)));
}
}
/** {@inheritDoc} */
@Override
public GradientField getField() {
return GradientField.getField(getFreeParameters());
}
/** Compute a<sup>x</sup> where a is a double and x a {@link Gradient}
* @param a number to exponentiate
* @param x power to apply
* @return a<sup>x</sup>
*/
public static Gradient pow(final double a, final Gradient x) {
if (a == 0) {
return x.getField().getZero();
} else {
final double aX = FastMath.pow(a, x.value);
final double aXlnA = aX * FastMath.log(a);
final Gradient result = x.newInstance(aX);
for (int i = 0; i < x.grad.length; ++i) {
result.grad[i] = aXlnA * x.grad[i];
}
return result;
}
}
/** {@inheritDoc} */
@Override
public Gradient pow(final double p) {
if (p == 0) {
return getField().getOne();
} else {
final double valuePm1 = FastMath.pow(value, p - 1);
return compose(valuePm1 * value, p * valuePm1);
}
}
/** {@inheritDoc} */
@Override
public Gradient pow(final int n) {
if (n == 0) {
return getField().getOne();
} else {
final double valueNm1 = FastMath.pow(value, n - 1);
return compose(valueNm1 * value, n * valueNm1);
}
}
/** {@inheritDoc} */
@Override
public Gradient pow(final Gradient e) {
return log().multiply(e).exp();
}
/** {@inheritDoc} */
@Override
public Gradient exp() {
final double exp = FastMath.exp(value);
return compose(exp, exp);
}
/** {@inheritDoc} */
@Override
public Gradient expm1() {
final double exp = FastMath.exp(value);
final double expM1 = FastMath.expm1(value);
return compose(expM1, exp);
}
/** {@inheritDoc} */
@Override
public Gradient log() {
return compose(FastMath.log(value), 1 / value);
}
/** {@inheritDoc} */
@Override
public Gradient log1p() {
return compose(FastMath.log1p(value), 1 / (1 + value));
}
/** {@inheritDoc} */
@Override
public Gradient log10() {
return compose(FastMath.log10(value), 1 / (value * FastMath.log(10.0)));
}
/** {@inheritDoc} */
@Override
public Gradient cos() {
final SinCos sinCos = FastMath.sinCos(value);
return compose(sinCos.cos(), -sinCos.sin());
}
/** {@inheritDoc} */
@Override
public Gradient sin() {
final SinCos sinCos = FastMath.sinCos(value);
return compose(sinCos.sin(), sinCos.cos());
}
/** {@inheritDoc} */
@Override
public FieldSinCos<Gradient> sinCos() {
final SinCos sinCos = FastMath.sinCos(value);
final Gradient sin = newInstance(sinCos.sin());
final Gradient cos = newInstance(sinCos.cos());
for (int i = 0; i < grad.length; ++i) {
sin.grad[i] = +grad[i] * sinCos.cos();
cos.grad[i] = -grad[i] * sinCos.sin();
}
return new FieldSinCos<>(sin, cos);
}
/** {@inheritDoc} */
@Override
public Gradient tan() {
final double tan = FastMath.tan(value);
return compose(tan, 1 + tan * tan);
}
/** {@inheritDoc} */
@Override
public Gradient acos() {
return compose(FastMath.acos(value), -1 / FastMath.sqrt(1 - value * value));
}
/** {@inheritDoc} */
@Override
public Gradient asin() {
return compose(FastMath.asin(value), 1 / FastMath.sqrt(1 - value * value));
}
/** {@inheritDoc} */
@Override
public Gradient atan() {
return compose(FastMath.atan(value), 1 / (1 + value * value));
}
/** {@inheritDoc} */
@Override
public Gradient atan2(final Gradient x) {
final double inv = 1.0 / (value * value + x.value * x.value);
final Gradient result = newInstance(FastMath.atan2(value, x.value));
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = (x.value * grad[i] - x.grad[i] * value) * inv;
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient cosh() {
return compose(FastMath.cosh(value), FastMath.sinh(value));
}
/** {@inheritDoc} */
@Override
public Gradient sinh() {
return compose(FastMath.sinh(value), FastMath.cosh(value));
}
/** {@inheritDoc} */
@Override
public FieldSinhCosh<Gradient> sinhCosh() {
final SinhCosh sinhCosh = FastMath.sinhCosh(value);
final Gradient sinh = newInstance(sinhCosh.sinh());
final Gradient cosh = newInstance(sinhCosh.cosh());
for (int i = 0; i < grad.length; ++i) {
sinh.grad[i] = grad[i] * sinhCosh.cosh();
cosh.grad[i] = grad[i] * sinhCosh.sinh();
}
return new FieldSinhCosh<>(sinh, cosh);
}
/** {@inheritDoc} */
@Override
public Gradient tanh() {
final double tanh = FastMath.tanh(value);
return compose(tanh, 1 - tanh * tanh);
}
/** {@inheritDoc} */
@Override
public Gradient acosh() {
return compose(FastMath.acosh(value), 1 / FastMath.sqrt(value * value - 1));
}
/** {@inheritDoc} */
@Override
public Gradient asinh() {
return compose(FastMath.asinh(value), 1 / FastMath.sqrt(value * value + 1));
}
/** {@inheritDoc} */
@Override
public Gradient atanh() {
return compose(FastMath.atanh(value), 1 / (1 - value * value));
}
/** {@inheritDoc} */
@Override
public Gradient toDegrees() {
final Gradient result = newInstance(FastMath.toDegrees(value));
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = FastMath.toDegrees(grad[i]);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient toRadians() {
final Gradient result = newInstance(FastMath.toRadians(value));
for (int i = 0; i < grad.length; ++i) {
result.grad[i] = FastMath.toRadians(grad[i]);
}
return result;
}
/** Evaluate Taylor expansion a derivative structure.
* @param delta parameters offsets (Δx, Δy, ...)
* @return value of the Taylor expansion at x + Δx, y + Δy, ...
*/
public double taylor(final double... delta) {
double result = value;
for (int i = 0; i < grad.length; ++i) {
result += delta[i] * grad[i];
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final Gradient[] a, final Gradient[] b) {
// extract values and first derivatives
final int n = a.length;
final double[] a0 = new double[n];
final double[] b0 = new double[n];
final double[] a1 = new double[2 * n];
final double[] b1 = new double[2 * n];
for (int i = 0; i < n; ++i) {
final Gradient ai = a[i];
final Gradient bi = b[i];
a0[i] = ai.value;
b0[i] = bi.value;
a1[2 * i] = ai.value;
b1[2 * i + 1] = bi.value;
}
final Gradient result = newInstance(MathArrays.linearCombination(a0, b0));
for (int k = 0; k < grad.length; ++k) {
for (int i = 0; i < n; ++i) {
a1[2 * i + 1] = a[i].grad[k];
b1[2 * i] = b[i].grad[k];
}
result.grad[k] = MathArrays.linearCombination(a1, b1);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final double[] a, final Gradient[] b) {
// extract values and first derivatives
final int n = b.length;
final double[] b0 = new double[n];
final double[] b1 = new double[n];
for (int i = 0; i < n; ++i) {
b0[i] = b[i].value;
}
final Gradient result = newInstance(MathArrays.linearCombination(a, b0));
for (int k = 0; k < grad.length; ++k) {
for (int i = 0; i < n; ++i) {
b1[i] = b[i].grad[k];
}
result.grad[k] = MathArrays.linearCombination(a, b1);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final Gradient a1, final Gradient b1,
final Gradient a2, final Gradient b2) {
final Gradient result = newInstance(MathArrays.linearCombination(a1.value, b1.value,
a2.value, b2.value));
for (int i = 0; i < b1.grad.length; ++i) {
result.grad[i] = MathArrays.linearCombination(a1.value, b1.grad[i],
a1.grad[i], b1.value,
a2.value, b2.grad[i],
a2.grad[i], b2.value);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final double a1, final Gradient b1,
final double a2, final Gradient b2) {
final Gradient result = newInstance(MathArrays.linearCombination(a1, b1.value,
a2, b2.value));
for (int i = 0; i < b1.grad.length; ++i) {
result.grad[i] = MathArrays.linearCombination(a1, b1.grad[i],
a2, b2.grad[i]);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final Gradient a1, final Gradient b1,
final Gradient a2, final Gradient b2,
final Gradient a3, final Gradient b3) {
final double[] a = {
a1.value, 0, a2.value, 0, a3.value, 0
};
final double[] b = {
0, b1.value, 0, b2.value, 0, b3.value
};
final Gradient result = newInstance(MathArrays.linearCombination(a1.value, b1.value,
a2.value, b2.value,
a3.value, b3.value));
for (int i = 0; i < b1.grad.length; ++i) {
a[1] = a1.grad[i];
a[3] = a2.grad[i];
a[5] = a3.grad[i];
b[0] = b1.grad[i];
b[2] = b2.grad[i];
b[4] = b3.grad[i];
result.grad[i] = MathArrays.linearCombination(a, b);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final double a1, final Gradient b1,
final double a2, final Gradient b2,
final double a3, final Gradient b3) {
final Gradient result = newInstance(MathArrays.linearCombination(a1, b1.value,
a2, b2.value,
a3, b3.value));
for (int i = 0; i < b1.grad.length; ++i) {
result.grad[i] = MathArrays.linearCombination(a1, b1.grad[i],
a2, b2.grad[i],
a3, b3.grad[i]);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final Gradient a1, final Gradient b1,
final Gradient a2, final Gradient b2,
final Gradient a3, final Gradient b3,
final Gradient a4, final Gradient b4) {
final double[] a = {
a1.value, 0, a2.value, 0, a3.value, 0, a4.value, 0
};
final double[] b = {
0, b1.value, 0, b2.value, 0, b3.value, 0, b4.value
};
final Gradient result = newInstance(MathArrays.linearCombination(a1.value, b1.value,
a2.value, b2.value,
a3.value, b3.value,
a4.value, b4.value));
for (int i = 0; i < b1.grad.length; ++i) {
a[1] = a1.grad[i];
a[3] = a2.grad[i];
a[5] = a3.grad[i];
a[7] = a4.grad[i];
b[0] = b1.grad[i];
b[2] = b2.grad[i];
b[4] = b3.grad[i];
b[6] = b4.grad[i];
result.grad[i] = MathArrays.linearCombination(a, b);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient linearCombination(final double a1, final Gradient b1,
final double a2, final Gradient b2,
final double a3, final Gradient b3,
final double a4, final Gradient b4) {
final Gradient result = newInstance(MathArrays.linearCombination(a1, b1.value,
a2, b2.value,
a3, b3.value,
a4, b4.value));
for (int i = 0; i < b1.grad.length; ++i) {
result.grad[i] = MathArrays.linearCombination(a1, b1.grad[i],
a2, b2.grad[i],
a3, b3.grad[i],
a4, b4.grad[i]);
}
return result;
}
/** {@inheritDoc} */
@Override
public Gradient getPi() {
return new Gradient(FastMath.PI, getFreeParameters());
}
/** Test for the equality of two univariate derivatives.
* <p>
* univariate derivatives are considered equal if they have the same derivatives.
* </p>
* @param other Object to test for equality to this
* @return true if two univariate derivatives are equal
*/
@Override
public boolean equals(Object other) {
if (this == other) {
return true;
}
if (other instanceof Gradient) {
final Gradient rhs = (Gradient) other;
return value == rhs.value && MathArrays.equals(grad, rhs.grad);
}
return false;
}
/** Get a hashCode for the univariate derivative.
* @return a hash code value for this object
*/
@Override
public int hashCode() {
return 129 + 7 * Double.hashCode(value) - 15 * Arrays.hashCode(grad);
}
}