Repository navigation
Expand file tree
/
Copy pathnp.math.gen.cs
More file actions
3130 lines (3034 loc) · 144 KB
/
Copy pathnp.math.gen.cs
File metadata and controls
3130 lines (3034 loc) · 144 KB
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
// Copyright (c) 2019 by the SciSharp Team
// Code generated by CodeMinion: https://github.com/SciSharp/CodeMinion
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;
using Python.Runtime;
using Numpy.Models;
namespace Numpy
{
public static partial class np
{
/// <summary>
/// Trigonometric sine, element-wise.
///
/// Notes
///
/// The sine is one of the fundamental functions of trigonometry (the
/// mathematical study of triangles). Consider a circle of radius 1
/// centered on the origin. A ray comes in from the axis, makes
/// an angle at the origin (measured counter-clockwise from that axis), and
/// departs from the origin. The coordinate of the outgoing
/// ray’s intersection with the unit circle is the sine of that angle. It
/// ranges from -1 for to +1 for The
/// function has zeroes where the angle is a multiple of .
/// Sines of angles between and are negative.
/// The numerous properties of the sine and related functions are included
/// in any standard trigonometry text.
/// </summary>
/// <param name="x">
/// Angle, in radians ( rad equals 360 degrees).
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The sine of each element of x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray sin(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.sin(x, @out:@out, @where:@where);
/// <summary>
/// Cosine element-wise.
///
/// Notes
///
/// If out is provided, the function writes the result into it,
/// and returns a reference to out. (See Examples)
///
/// References
///
/// M. Abramowitz and I. A. Stegun, Handbook of Mathematical Functions.
/// New York, NY: Dover, 1972.
/// </summary>
/// <param name="x">
/// Input array in radians.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding cosine values.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray cos(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.cos(x, @out:@out, @where:@where);
/// <summary>
/// Compute tangent element-wise.
///
/// Equivalent to np.sin(x)/np.cos(x) element-wise.
///
/// Notes
///
/// If out is provided, the function writes the result into it,
/// and returns a reference to out. (See Examples)
///
/// References
///
/// M. Abramowitz and I. A. Stegun, Handbook of Mathematical Functions.
/// New York, NY: Dover, 1972.
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding tangent values.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray tan(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.tan(x, @out:@out, @where:@where);
/// <summary>
/// Inverse sine, element-wise.
///
/// Notes
///
/// arcsin is a multivalued function: for each x there are infinitely
/// many numbers z such that . The convention is to
/// return the angle z whose real part lies in [-pi/2, pi/2].
///
/// For real-valued input data types, arcsin always returns real output.
/// For each value that cannot be expressed as a real number or infinity,
/// it yields nan and sets the invalid floating point error flag.
///
/// For complex-valued input, arcsin is a complex analytic function that
/// has, by convention, the branch cuts [-inf, -1] and [1, inf] and is
/// continuous from above on the former and from below on the latter.
///
/// The inverse sine is also known as asin or sin^{-1}.
///
/// References
///
/// Abramowitz, M. and Stegun, I. A., Handbook of Mathematical Functions,
/// 10th printing, New York: Dover, 1964, pp. 79ff.
/// http://www.math.sfu.ca/~cbm/aands/
/// </summary>
/// <param name="x">
/// y-coordinate on the unit circle.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The inverse sine of each element in x, in radians and in the
/// closed interval [-pi/2, pi/2].
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray arcsin(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.arcsin(x, @out:@out, @where:@where);
/// <summary>
/// Trigonometric inverse cosine, element-wise.
///
/// The inverse of cos so that, if y = cos(x), then x = arccos(y).
///
/// Notes
///
/// arccos is a multivalued function: for each x there are infinitely
/// many numbers z such that cos(z) = x. The convention is to return
/// the angle z whose real part lies in [0, pi].
///
/// For real-valued input data types, arccos always returns real output.
/// For each value that cannot be expressed as a real number or infinity,
/// it yields nan and sets the invalid floating point error flag.
///
/// For complex-valued input, arccos is a complex analytic function that
/// has branch cuts [-inf, -1] and [1, inf] and is continuous from
/// above on the former and from below on the latter.
///
/// The inverse cos is also known as acos or cos^-1.
///
/// References
///
/// M. Abramowitz and I.A. Stegun, “Handbook of Mathematical Functions”,
/// 10th printing, 1964, pp. 79. http://www.math.sfu.ca/~cbm/aands/
/// </summary>
/// <param name="x">
/// x-coordinate on the unit circle.
/// For real arguments, the domain is [-1, 1].
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The angle of the ray intersecting the unit circle at the given
/// x-coordinate in radians [0, pi].
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray arccos(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.arccos(x, @out:@out, @where:@where);
/// <summary>
/// Trigonometric inverse tangent, element-wise.
///
/// The inverse of tan, so that if y = tan(x) then x = arctan(y).
///
/// Notes
///
/// arctan is a multi-valued function: for each x there are infinitely
/// many numbers z such that tan(z) = x. The convention is to return
/// the angle z whose real part lies in [-pi/2, pi/2].
///
/// For real-valued input data types, arctan always returns real output.
/// For each value that cannot be expressed as a real number or infinity,
/// it yields nan and sets the invalid floating point error flag.
///
/// For complex-valued input, arctan is a complex analytic function that
/// has [1j, infj] and [-1j, -infj] as branch cuts, and is continuous
/// from the left on the former and from the right on the latter.
///
/// The inverse tangent is also known as atan or tan^{-1}.
///
/// References
///
/// Abramowitz, M. and Stegun, I. A., Handbook of Mathematical Functions,
/// 10th printing, New York: Dover, 1964, pp. 79.
/// http://www.math.sfu.ca/~cbm/aands/
/// </summary>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// Out has the same shape as x. Its real part is in
/// [-pi/2, pi/2] (arctan(+/-inf) returns +/-pi/2).
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray arctan(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.arctan(x, @out:@out, @where:@where);
/// <summary>
/// Given the “legs” of a right triangle, return its hypotenuse.
///
/// Equivalent to sqrt(x1**2 + x2**2), element-wise. If x1 or
/// x2 is scalar_like (i.e., unambiguously cast-able to a scalar type),
/// it is broadcast for use with each element of the other argument.
/// (See Examples)
/// </summary>
/// <param name="x2">
/// Leg of the triangle(s).
/// </param>
/// <param name="x1">
/// Leg of the triangle(s).
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The hypotenuse of the triangle(s).
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray hypot(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.hypot(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Element-wise arc tangent of x1/x2 choosing the quadrant correctly.
///
/// The quadrant (i.e., branch) is chosen so that arctan2(x1, x2) is
/// the signed angle in radians between the ray ending at the origin and
/// passing through the point (1,0), and the ray ending at the origin and
/// passing through the point (x2, x1). (Note the role reversal: the
/// “y-coordinate” is the first function parameter, the “x-coordinate”
/// is the second.) By IEEE convention, this function is defined for
/// x2 = +/-0 and for either or both of x1 and x2 = +/-inf (see
/// Notes for specific values).
///
/// This function is not defined for complex-valued arguments; for the
/// so-called argument of complex values, use angle.
///
/// Notes
///
/// arctan2 is identical to the atan2 function of the underlying
/// C library. The following special values are defined in the C
/// standard: [1]
///
/// Note that +0 and -0 are distinct floating point numbers, as are +inf
/// and -inf.
///
/// References
/// </summary>
/// <param name="x1">
/// y-coordinates.
/// </param>
/// <param name="x2">
/// x-coordinates. x2 must be broadcastable to match the shape of
/// x1 or vice versa.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// Array of angles in radians, in the range [-pi, pi].
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray arctan2(NDarray x1, NDarray x2, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.arctan2(x1, x2, @out:@out, @where:@where);
/// <summary>
/// Convert angles from radians to degrees.
/// </summary>
/// <param name="x">
/// Input array in radians.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding degree values; if out was supplied this is a
/// reference to it.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray degrees(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.degrees(x, @out:@out, @where:@where);
/// <summary>
/// Convert angles from degrees to radians.
/// </summary>
/// <param name="x">
/// Input array in degrees.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding radian values.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray radians(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.radians(x, @out:@out, @where:@where);
/// <summary>
/// Unwrap by changing deltas between values to 2*pi complement.
///
/// Unwrap radian phase p by changing absolute jumps greater than
/// discont to their 2*pi complement along the given axis.
///
/// Notes
///
/// If the discontinuity in p is smaller than pi, but larger than
/// discont, no unwrapping is done because taking the 2*pi complement
/// would only make the discontinuity larger.
/// </summary>
/// <param name="p">
/// Input array.
/// </param>
/// <param name="discont">
/// Maximum discontinuity between values, default is pi.
/// </param>
/// <param name="axis">
/// Axis along which unwrap will operate, default is the last axis.
/// </param>
/// <returns>
/// Output array.
/// </returns>
public static NDarray unwrap(NDarray p, float? discont = 3.141592653589793f, int? axis = -1)
=> NumPy.Instance.unwrap(p, discont:discont, axis:axis);
/// <summary>
/// Convert angles from degrees to radians.
///
/// Notes
///
/// deg2rad(x) is x * pi / 180.
/// </summary>
/// <param name="x">
/// Angles in degrees.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding angle in radians.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray deg2rad(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.deg2rad(x, @out:@out, @where:@where);
/// <summary>
/// Convert angles from radians to degrees.
///
/// Notes
///
/// rad2deg(x) is 180 * x / pi.
/// </summary>
/// <param name="x">
/// Angle in radians.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding angle in degrees.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray rad2deg(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.rad2deg(x, @out:@out, @where:@where);
/// <summary>
/// Hyperbolic sine, element-wise.
///
/// Equivalent to 1/2 * (np.exp(x) - np.exp(-x)) or
/// -1j * np.sin(1j*x).
///
/// Notes
///
/// If out is provided, the function writes the result into it,
/// and returns a reference to out. (See Examples)
///
/// References
///
/// M. Abramowitz and I. A. Stegun, Handbook of Mathematical Functions.
/// New York, NY: Dover, 1972, pg. 83.
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding hyperbolic sine values.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray sinh(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.sinh(x, @out:@out, @where:@where);
/// <summary>
/// Hyperbolic cosine, element-wise.
///
/// Equivalent to 1/2 * (np.exp(x) + np.exp(-x)) and np.cos(1j*x).
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// Output array of same shape as x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray cosh(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.cosh(x, @out:@out, @where:@where);
/// <summary>
/// Compute hyperbolic tangent element-wise.
///
/// Equivalent to np.sinh(x)/np.cosh(x) or -1j * np.tan(1j*x).
///
/// Notes
///
/// If out is provided, the function writes the result into it,
/// and returns a reference to out. (See Examples)
///
/// References
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The corresponding hyperbolic tangent values.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray tanh(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.tanh(x, @out:@out, @where:@where);
/// <summary>
/// Inverse hyperbolic sine element-wise.
///
/// Notes
///
/// arcsinh is a multivalued function: for each x there are infinitely
/// many numbers z such that sinh(z) = x. The convention is to return the
/// z whose imaginary part lies in [-pi/2, pi/2].
///
/// For real-valued input data types, arcsinh always returns real output.
/// For each value that cannot be expressed as a real number or infinity, it
/// returns nan and sets the invalid floating point error flag.
///
/// For complex-valued input, arccos is a complex analytical function that
/// has branch cuts [1j, infj] and [-1j, -infj] and is continuous from
/// the right on the former and from the left on the latter.
///
/// The inverse hyperbolic sine is also known as asinh or sinh^-1.
///
/// References
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// Array of the same shape as x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray arcsinh(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.arcsinh(x, @out:@out, @where:@where);
/// <summary>
/// Inverse hyperbolic cosine, element-wise.
///
/// Notes
///
/// arccosh is a multivalued function: for each x there are infinitely
/// many numbers z such that cosh(z) = x. The convention is to return the
/// z whose imaginary part lies in [-pi, pi] and the real part in
/// [0, inf].
///
/// For real-valued input data types, arccosh always returns real output.
/// For each value that cannot be expressed as a real number or infinity, it
/// yields nan and sets the invalid floating point error flag.
///
/// For complex-valued input, arccosh is a complex analytical function that
/// has a branch cut [-inf, 1] and is continuous from above on it.
///
/// References
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// Array of the same shape as x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray arccosh(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.arccosh(x, @out:@out, @where:@where);
/// <summary>
/// Inverse hyperbolic tangent element-wise.
///
/// Notes
///
/// arctanh is a multivalued function: for each x there are infinitely
/// many numbers z such that tanh(z) = x. The convention is to return
/// the z whose imaginary part lies in [-pi/2, pi/2].
///
/// For real-valued input data types, arctanh always returns real output.
/// For each value that cannot be expressed as a real number or infinity,
/// it yields nan and sets the invalid floating point error flag.
///
/// For complex-valued input, arctanh is a complex analytical function
/// that has branch cuts [-1, -inf] and [1, inf] and is continuous from
/// above on the former and from below on the latter.
///
/// The inverse hyperbolic tangent is also known as atanh or tanh^-1.
///
/// References
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// Array of the same shape as x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray arctanh(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.arctanh(x, @out:@out, @where:@where);
/// <summary>
/// Evenly round to the given number of decimals.
///
/// Notes
///
/// For values exactly halfway between rounded decimal values, NumPy
/// rounds to the nearest even value. Thus 1.5 and 2.5 round to 2.0,
/// -0.5 and 0.5 round to 0.0, etc. Results may also be surprising due
/// to the inexact representation of decimal fractions in the IEEE
/// floating point standard [1] and errors introduced when scaling
/// by powers of ten.
///
/// References
/// </summary>
/// <param name="a">
/// Input data.
/// </param>
/// <param name="decimals">
/// Number of decimal places to round to (default: 0). If
/// decimals is negative, it specifies the number of positions to
/// the left of the decimal point.
/// </param>
/// <param name="@out">
/// Alternative output array in which to place the result. It must have
/// the same shape as the expected output, but the type of the output
/// values will be cast if necessary. See doc.ufuncs (Section
/// “Output arguments”) for details.
/// </param>
/// <returns>
/// An array of the same type as a, containing the rounded values.
/// Unless out was specified, a new array is created. A reference to
/// the result is returned.
///
/// The real and imaginary parts of complex numbers are rounded
/// separately. The result of rounding a float is a float.
/// </returns>
public static NDarray around(NDarray a, int? decimals = 0, NDarray @out = null)
=> NumPy.Instance.around(a, decimals:decimals, @out:@out);
/// <summary>
/// Round elements of the array to the nearest integer.
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// Output array is same shape and type as x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray rint(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.rint(x, @out:@out, @where:@where);
/// <summary>
/// Round to nearest integer towards zero.
///
/// Round an array of floats element-wise to nearest integer towards zero.
/// The rounded values are returned as floats.
/// </summary>
/// <param name="x">
/// An array of floats to be rounded
/// </param>
/// <param name="y">
/// Output array
/// </param>
/// <returns>
/// The array of rounded numbers
/// </returns>
public static NDarray fix(NDarray x, NDarray y = null)
=> NumPy.Instance.fix(x, y:y);
/// <summary>
/// Return the floor of the input, element-wise.
///
/// The floor of the scalar x is the largest integer i, such that
/// i <= x. It is often denoted as .
///
/// Notes
///
/// Some spreadsheet programs calculate the “floor-towards-zero”, in other
/// words floor(-2.5) == -2. NumPy instead uses the definition of
/// floor where floor(-2.5) == -3.
/// </summary>
/// <param name="x">
/// Input data.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The floor of each element in x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray floor(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.floor(x, @out:@out, @where:@where);
/// <summary>
/// Return the ceiling of the input, element-wise.
///
/// The ceil of the scalar x is the smallest integer i, such that
/// i >= x. It is often denoted as .
/// </summary>
/// <param name="x">
/// Input data.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The ceiling of each element in x, with float dtype.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray ceil(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.ceil(x, @out:@out, @where:@where);
/// <summary>
/// Return the truncated value of the input, element-wise.
///
/// The truncated value of the scalar x is the nearest integer i which
/// is closer to zero than x is. In short, the fractional part of the
/// signed number x is discarded.
///
/// Notes
/// </summary>
/// <param name="x">
/// Input data.
/// </param>
/// <param name="@out">
/// A location into which the result is stored. If provided, it must have
/// a shape that the inputs broadcast to. If not provided or None,
/// a freshly-allocated array is returned. A tuple (possible only as a
/// keyword argument) must have length equal to the number of outputs.
/// </param>
/// <param name="@where">
/// Values of True indicate to calculate the ufunc at that position, values
/// of False indicate to leave the value in the output alone.
/// </param>
/// <returns>
/// The truncated value of each element in x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray trunc(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.trunc(x, @out:@out, @where:@where);
/// <summary>
/// Return the product of array elements over a given axis.
///
/// Notes
///
/// Arithmetic is modular when using integer types, and no error is
/// raised on overflow. That means that, on a 32-bit platform:
///
/// The product of an empty array is the neutral element 1:
/// </summary>
/// <param name="a">
/// Input data.
/// </param>
/// <param name="axis">
/// Axis or axes along which a product is performed. The default,
/// axis=None, will calculate the product of all the elements in the
/// input array. If axis is negative it counts from the last to the
/// first axis.
///
/// If axis is a tuple of ints, a product is performed on all of the
/// axes specified in the tuple instead of a single axis or all the
/// axes as before.
/// </param>
/// <param name="dtype">
/// The type of the returned array, as well as of the accumulator in
/// which the elements are multiplied. The dtype of a is used by
/// default unless a has an integer dtype of less precision than the
/// default platform integer. In that case, if a is signed then the
/// platform integer is used while if a is unsigned then an unsigned
/// integer of the same precision as the platform integer is used.
/// </param>
/// <param name="@out">
/// Alternative output array in which to place the result. It must have
/// the same shape as the expected output, but the type of the output
/// values will be cast if necessary.
/// </param>
/// <param name="keepdims">
/// If this is set to True, the axes which are reduced are left in the
/// result as dimensions with size one. With this option, the result
/// will broadcast correctly against the input array.
///
/// If the default value is passed, then keepdims will not be
/// passed through to the prod method of sub-classes of
/// ndarray, however any non-default value will be. If the
/// sub-class’ method does not implement keepdims any
/// exceptions will be raised.
/// </param>
/// <param name="initial">
/// The starting value for this product. See reduce for details.
/// </param>
/// <returns>
/// An array shaped as a but with the specified axis removed.
/// Returns a reference to out if specified.
/// </returns>
public static NDarray prod(NDarray a, int[] axis = null, Dtype dtype = null, NDarray @out = null, bool? keepdims = null, ValueType initial = null)
=> NumPy.Instance.prod(a, axis:axis, dtype:dtype, @out:@out, keepdims:keepdims, initial:initial);
/// <summary>
/// Sum of array elements over a given axis.
///
/// Notes
///
/// Arithmetic is modular when using integer types, and no error is
/// raised on overflow.
///
/// The sum of an empty array is the neutral element 0:
/// </summary>
/// <param name="a">
/// Elements to sum.
/// </param>
/// <param name="axis">
/// Axis or axes along which a sum is performed. The default,
/// axis=None, will sum all of the elements of the input array. If
/// axis is negative it counts from the last to the first axis.
///
/// If axis is a tuple of ints, a sum is performed on all of the axes
/// specified in the tuple instead of a single axis or all the axes as
/// before.
/// </param>
/// <param name="dtype">
/// The type of the returned array and of the accumulator in which the
/// elements are summed. The dtype of a is used by default unless a
/// has an integer dtype of less precision than the default platform
/// integer. In that case, if a is signed then the platform integer
/// is used while if a is unsigned then an unsigned integer of the
/// same precision as the platform integer is used.
/// </param>
/// <param name="@out">
/// Alternative output array in which to place the result. It must have
/// the same shape as the expected output, but the type of the output
/// values will be cast if necessary.
/// </param>
/// <param name="keepdims">
/// If this is set to True, the axes which are reduced are left
/// in the result as dimensions with size one. With this option,
/// the result will broadcast correctly against the input array.
///
/// If the default value is passed, then keepdims will not be
/// passed through to the sum method of sub-classes of
/// ndarray, however any non-default value will be. If the
/// sub-class’ method does not implement keepdims any
/// exceptions will be raised.
/// </param>
/// <param name="initial">
/// Starting value for the sum. See reduce for details.
/// </param>
/// <returns>
/// An array with the same shape as a, with the specified
/// axis removed. If a is a 0-d array, or if axis is None, a scalar
/// is returned. If an output array is specified, a reference to
/// out is returned.
/// </returns>
public static NDarray sum(NDarray a, int[] axis = null, Dtype dtype = null, NDarray @out = null, bool? keepdims = null, ValueType initial = null)
=> NumPy.Instance.sum(a, axis:axis, dtype:dtype, @out:@out, keepdims:keepdims, initial:initial);
/// <summary>
/// Return the product of array elements over a given axis treating Not a
/// Numbers (NaNs) as ones.
///
/// One is returned for slices that are all-NaN or empty.
/// </summary>
/// <param name="a">
/// Array containing numbers whose product is desired. If a is not an
/// array, a conversion is attempted.
/// </param>
/// <param name="axis">
/// Axis or axes along which the product is computed. The default is to compute
/// the product of the flattened array.
/// </param>
/// <param name="dtype">
/// The type of the returned array and of the accumulator in which the
/// elements are summed. By default, the dtype of a is used. An
/// exception is when a has an integer type with less precision than
/// the platform (u)intp. In that case, the default will be either
/// (u)int32 or (u)int64 depending on whether the platform is 32 or 64
/// bits. For inexact inputs, dtype must be inexact.
/// </param>
/// <param name="@out">
/// Alternate output array in which to place the result. The default
/// is None. If provided, it must have the same shape as the
/// expected output, but the type will be cast if necessary. See
/// doc.ufuncs for details. The casting of NaN to integer can yield
/// unexpected results.
/// </param>
/// <param name="keepdims">
/// If True, the axes which are reduced are left in the result as
/// dimensions with size one. With this option, the result will
/// broadcast correctly against the original arr.