Repository navigation
Expand file tree
/
Copy pathnp.logic.gen.cs
More file actions
855 lines (821 loc) · 39.1 KB
/
Copy pathnp.logic.gen.cs
File metadata and controls
855 lines (821 loc) · 39.1 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
// 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>
/// Test whether all array elements along a given axis evaluate to True.
///
/// Notes
///
/// Not a Number (NaN), positive infinity and negative infinity
/// evaluate to True because these are not equal to zero.
/// </summary>
/// <param name="a">
/// Input array or object that can be converted to an array.
/// </param>
/// <param name="axis">
/// Axis or axes along which a logical AND reduction is performed.
/// The default (axis = None) is to perform a logical AND over all
/// the dimensions of the input array. axis may be negative, in
/// which case it counts from the last to the first axis.
///
/// If this is a tuple of ints, a reduction is performed on multiple
/// axes, instead of a single axis or all the axes as before.
/// </param>
/// <param name="@out">
/// Alternate output array in which to place the result.
/// It must have the same shape as the expected output and its
/// type is preserved (e.g., if dtype(out) is float, the result
/// will consist of 0.0’s and 1.0’s). See doc.ufuncs (Section
/// “Output arguments”) for more details.
/// </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 all 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>
/// <returns>
/// A new boolean or array is returned unless out is specified,
/// in which case a reference to out is returned.
/// </returns>
public static NDarray<bool> all(NDarray a, int[] axis, NDarray @out = null, bool? keepdims = null)
=> NumPy.Instance.all(a, axis:axis, @out:@out, keepdims:keepdims);
/// <summary>
/// Test whether all array elements along a given axis evaluate to True.
///
/// Notes
///
/// Not a Number (NaN), positive infinity and negative infinity
/// evaluate to True because these are not equal to zero.
/// </summary>
/// <param name="a">
/// Input array or object that can be converted to an array.
/// </param>
/// <returns>
/// A new boolean or array is returned unless out is specified,
/// in which case a reference to out is returned.
/// </returns>
public static bool all(NDarray a)
=> NumPy.Instance.all(a);
/// <summary>
/// Test whether any array element along a given axis evaluates to True.
///
/// Returns single boolean unless axis is not None
///
/// Notes
///
/// Not a Number (NaN), positive infinity and negative infinity evaluate
/// to True because these are not equal to zero.
/// </summary>
/// <param name="a">
/// Input array or object that can be converted to an array.
/// </param>
/// <param name="axis">
/// Axis or axes along which a logical OR reduction is performed.
/// The default (axis = None) is to perform a logical OR over all
/// the dimensions of the input array. axis may be negative, in
/// which case it counts from the last to the first axis.
///
/// If this is a tuple of ints, a reduction is performed on multiple
/// axes, instead of a single axis or all the axes as before.
/// </param>
/// <param name="@out">
/// Alternate output array in which to place the result. It must have
/// the same shape as the expected output and its type is preserved
/// (e.g., if it is of type float, then it will remain so, returning
/// 1.0 for True and 0.0 for False, regardless of the type of a).
/// See doc.ufuncs (Section “Output arguments”) for details.
/// </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 any 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>
/// <returns>
/// A new boolean or ndarray is returned unless out is specified,
/// in which case a reference to out is returned.
/// </returns>
public static NDarray<bool> any(NDarray a, int[] axis, NDarray @out = null, bool? keepdims = null)
=> NumPy.Instance.any(a, axis:axis, @out:@out, keepdims:keepdims);
/// <summary>
/// Test whether any array element along a given axis evaluates to True.
///
/// Returns single boolean unless axis is not None
///
/// Notes
///
/// Not a Number (NaN), positive infinity and negative infinity evaluate
/// to True because these are not equal to zero.
/// </summary>
/// <param name="a">
/// Input array or object that can be converted to an array.
/// </param>
/// <returns>
/// A new boolean or ndarray is returned unless out is specified,
/// in which case a reference to out is returned.
/// </returns>
public static bool any(NDarray a)
=> NumPy.Instance.any(a);
/// <summary>
/// Test element-wise for finiteness (not infinity or not Not a Number).
///
/// The result is returned as a boolean array.
///
/// Notes
///
/// Not a Number, positive infinity and negative infinity are considered
/// to be non-finite.
///
/// NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic
/// (IEEE 754). This means that Not a Number is not equivalent to infinity.
/// Also that positive infinity is not equivalent to negative infinity. But
/// infinity is equivalent to positive infinity. Errors result if the
/// second argument is also supplied when x is a scalar input, or if
/// first and second arguments have different shapes.
/// </summary>
/// <param name="x">
/// Input values.
/// </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>
/// True where x is not positive infinity, negative infinity,
/// or NaN; false otherwise.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray isfinite(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.isfinite(x, @out:@out, @where:@where);
/// <summary>
/// Test element-wise for positive or negative infinity.
///
/// Returns a boolean array of the same shape as x, True where x ==
/// +/-inf, otherwise False.
///
/// Notes
///
/// NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic
/// (IEEE 754).
///
/// Errors result if the second argument is supplied when the first
/// argument is a scalar, or if the first and second arguments have
/// different shapes.
/// </summary>
/// <param name="x">
/// Input values
/// </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>
/// True where x is positive or negative infinity, false otherwise.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray<bool> isinf(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.isinf(x, @out:@out, @where:@where);
/// <summary>
/// Test element-wise for NaN and return result as a boolean array.
///
/// Notes
///
/// NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic
/// (IEEE 754). This means that Not a Number is not equivalent to infinity.
/// </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>
/// True where x is NaN, false otherwise.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray isnan(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.isnan(x, @out:@out, @where:@where);
/// <summary>
/// Test element-wise for NaT (not a time) and return result as a boolean array.
/// </summary>
/// <param name="x">
/// Input array with datetime or timedelta data type.
/// </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>
/// True where x is NaT, false otherwise.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray isnat(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.isnat(x, @out:@out, @where:@where);
/// <summary>
/// Test element-wise for negative infinity, return result as bool array.
///
/// Notes
///
/// NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic
/// (IEEE 754).
///
/// Errors result if the second argument is also supplied when x is a scalar
/// input, if first and second arguments have different shapes, or if the
/// first argument has complex values.
/// </summary>
/// <param name="x">
/// The input array.
/// </param>
/// <param name="@out">
/// A boolean array with the same shape and type as x to store the
/// result.
/// </param>
/// <returns>
/// A boolean array with the same dimensions as the input.
/// If second argument is not supplied then a numpy boolean array is
/// returned with values True where the corresponding element of the
/// input is negative infinity and values False where the element of
/// the input is not negative infinity.
///
/// If a second argument is supplied the result is stored there. If the
/// type of that array is a numeric type the result is represented as
/// zeros and ones, if the type is boolean then as False and True. The
/// return value out is then a reference to that array.
/// </returns>
public static NDarray isneginf(NDarray x, NDarray @out = null)
=> NumPy.Instance.isneginf(x, @out:@out);
/// <summary>
/// Test element-wise for positive infinity, return result as bool array.
///
/// Notes
///
/// NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic
/// (IEEE 754).
///
/// Errors result if the second argument is also supplied when x is a scalar
/// input, if first and second arguments have different shapes, or if the
/// first argument has complex values
/// </summary>
/// <param name="x">
/// The input array.
/// </param>
/// <param name="y">
/// A boolean array with the same shape as x to store the result.
/// </param>
/// <returns>
/// A boolean array with the same dimensions as the input.
/// If second argument is not supplied then a boolean array is returned
/// with values True where the corresponding element of the input is
/// positive infinity and values False where the element of the input is
/// not positive infinity.
///
/// If a second argument is supplied the result is stored there. If the
/// type of that array is a numeric type the result is represented as zeros
/// and ones, if the type is boolean then as False and True.
/// The return value out is then a reference to that array.
/// </returns>
public static NDarray isposinf(NDarray x, NDarray y = null)
=> NumPy.Instance.isposinf(x, y:y);
/// <summary>
/// Returns a bool array, where True if input element is complex.
///
/// What is tested is whether the input has a non-zero imaginary part, not if
/// the input type is complex.
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <returns>
/// Output array.
/// </returns>
public static NDarray iscomplex(NDarray x)
=> NumPy.Instance.iscomplex(x);
/// <summary>
/// Check for a complex type or an array of complex numbers.
///
/// The type of the input is checked, not the value. Even if the input
/// has an imaginary part equal to zero, iscomplexobj evaluates to True.
/// </summary>
/// <param name="x">
/// The input can be of any type and shape.
/// </param>
/// <returns>
/// The return value, True if x is of a complex type or has at least
/// one complex element.
/// </returns>
public static bool iscomplexobj(object x)
=> NumPy.Instance.iscomplexobj(x);
/// <summary>
/// Returns True if the array is Fortran contiguous but not C contiguous.
///
/// This function is obsolete and, because of changes due to relaxed stride
/// checking, its return value for the same array may differ for versions
/// of NumPy >= 1.10.0 and previous versions. If you only want to check if an
/// array is Fortran contiguous use a.flags.f_contiguous instead.
/// </summary>
/// <param name="a">
/// Input array.
/// </param>
public static bool isfortran(NDarray a)
=> NumPy.Instance.isfortran(a);
/// <summary>
/// Returns a bool array, where True if input element is real.
///
/// If element has complex type with zero complex part, the return value
/// for that element is True.
/// </summary>
/// <param name="x">
/// Input array.
/// </param>
/// <returns>
/// Boolean array of same shape as x.
/// </returns>
public static NDarray isreal(NDarray x)
=> NumPy.Instance.isreal(x);
/// <summary>
/// Return True if x is a not complex type or an array of complex numbers.
///
/// The type of the input is checked, not the value. So even if the input
/// has an imaginary part equal to zero, isrealobj evaluates to False
/// if the data type is complex.
/// </summary>
/// <param name="x">
/// The input can be of any type and shape.
/// </param>
/// <returns>
/// The return value, False if x is of a complex type.
/// </returns>
public static bool isrealobj(object x)
=> NumPy.Instance.isrealobj(x);
/// <summary>
/// Returns True if the type of num is a scalar type.
///
/// Notes
///
/// In almost all cases np.ndim(x) == 0 should be used instead of this
/// function, as that will also return true for 0d arrays. This is how
/// numpy overloads functions in the style of the dx arguments to gradient
/// and the bins argument to histogram. Some key differences:
/// </summary>
/// <param name="num">
/// Input argument, can be of any type and shape.
/// </param>
/// <returns>
/// True if num is a scalar type, False if it is not.
/// </returns>
public static bool isscalar(object num)
=> NumPy.Instance.isscalar(num);
/// <summary>
/// Compute the truth value of x1 AND x2 element-wise.
/// </summary>
/// <param name="x2">
/// Input arrays. x1 and x2 must be of the same shape.
/// </param>
/// <param name="x1">
/// Input arrays. x1 and x2 must be of the same shape.
/// </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>
/// Boolean result with the same shape as x1 and x2 of the logical
/// AND operation on corresponding elements of x1 and x2.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray logical_and(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.logical_and(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Compute the truth value of x1 OR x2 element-wise.
/// </summary>
/// <param name="x2">
/// Logical OR is applied to the elements of x1 and x2.
/// They have to be of the same shape.
/// </param>
/// <param name="x1">
/// Logical OR is applied to the elements of x1 and x2.
/// They have to be of the same shape.
/// </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>
/// Boolean result with the same shape as x1 and x2 of the logical
/// OR operation on elements of x1 and x2.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray logical_or(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.logical_or(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Compute the truth value of NOT x element-wise.
/// </summary>
/// <param name="x">
/// Logical NOT is applied to the elements of x.
/// </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>
/// Boolean result with the same shape as x of the NOT operation
/// on elements of x.
/// This is a scalar if x is a scalar.
/// </returns>
public static NDarray<bool> logical_not(NDarray x, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.logical_not(x, @out:@out, @where:@where);
/// <summary>
/// Compute the truth value of x1 XOR x2, element-wise.
/// </summary>
/// <param name="x2">
/// Logical XOR is applied to the elements of x1 and x2. They must
/// be broadcastable to the same shape.
/// </param>
/// <param name="x1">
/// Logical XOR is applied to the elements of x1 and x2. They must
/// be broadcastable to the same shape.
/// </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>
/// Boolean result of the logical XOR operation applied to the elements
/// of x1 and x2; the shape is determined by whether or not
/// broadcasting of one or both arrays was required.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray<bool> logical_xor(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.logical_xor(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Returns True if two arrays are element-wise equal within a tolerance.
///
/// The tolerance values are positive, typically very small numbers. The
/// relative difference (rtol * abs(b)) and the absolute difference
/// atol are added together to compare against the absolute difference
/// between a and b.
///
/// If either array contains one or more NaNs, False is returned.
/// Infs are treated as equal if they are in the same place and of the same
/// sign in both arrays.
///
/// Notes
///
/// If the following equation is element-wise True, then allclose returns
/// True.
///
/// The above equation is not symmetric in a and b, so that
/// allclose(a, b) might be different from allclose(b, a) in
/// some rare cases.
///
/// The comparison of a and b uses standard broadcasting, which
/// means that a and b need not have the same shape in order for
/// allclose(a, b) to evaluate to True. The same is true for
/// equal but not array_equal.
/// </summary>
/// <param name="b">
/// Input arrays to compare.
/// </param>
/// <param name="a">
/// Input arrays to compare.
/// </param>
/// <param name="rtol">
/// The relative tolerance parameter (see Notes).
/// </param>
/// <param name="atol">
/// The absolute tolerance parameter (see Notes).
/// </param>
/// <param name="equal_nan">
/// Whether to compare NaN’s as equal. If True, NaN’s in a will be
/// considered equal to NaN’s in b in the output array.
/// </param>
/// <returns>
/// Returns True if the two arrays are equal within the given
/// tolerance; False otherwise.
/// </returns>
public static bool allclose(NDarray b, NDarray a, float rtol = 1e-05f, float atol = 1e-08f, bool equal_nan = false)
=> NumPy.Instance.allclose(b, a, rtol, atol, equal_nan);
/// <summary>
/// Returns a boolean array where two arrays are element-wise equal within a
/// tolerance.
///
/// The tolerance values are positive, typically very small numbers. The
/// relative difference (rtol * abs(b)) and the absolute difference
/// atol are added together to compare against the absolute difference
/// between a and b.
///
/// Notes
///
/// For finite values, isclose uses the following equation to test whether
/// two floating point values are equivalent.
///
/// Unlike the built-in math.isclose, the above equation is not symmetric
/// in a and b – it assumes b is the reference value – so that
/// isclose(a, b) might be different from isclose(b, a). Furthermore,
/// the default value of atol is not zero, and is used to determine what
/// small values should be considered close to zero. The default value is
/// appropriate for expected values of order unity: if the expected values
/// are significantly smaller than one, it can result in false positives.
/// atol should be carefully selected for the use case at hand. A zero value
/// for atol will result in False if either a or b is zero.
/// </summary>
/// <param name="b">
/// Input arrays to compare.
/// </param>
/// <param name="a">
/// Input arrays to compare.
/// </param>
/// <param name="rtol">
/// The relative tolerance parameter (see Notes).
/// </param>
/// <param name="atol">
/// The absolute tolerance parameter (see Notes).
/// </param>
/// <param name="equal_nan">
/// Whether to compare NaN’s as equal. If True, NaN’s in a will be
/// considered equal to NaN’s in b in the output array.
/// </param>
/// <returns>
/// Returns a boolean array of where a and b are equal within the
/// given tolerance. If both a and b are scalars, returns a single
/// boolean value.
/// </returns>
public static NDarray isclose(NDarray b, NDarray a, float rtol = 1e-05f, float atol = 1e-08f, bool equal_nan = false)
=> NumPy.Instance.isclose(b, a, rtol, atol, equal_nan);
/// <summary>
/// True if two arrays have the same shape and elements, False otherwise.
/// </summary>
/// <param name="a2">
/// Input arrays.
/// </param>
/// <param name="a1">
/// Input arrays.
/// </param>
/// <returns>
/// Returns True if the arrays are equal.
/// </returns>
public static bool array_equal(NDarray a2, NDarray a1)
=> NumPy.Instance.array_equal(a2, a1);
/// <summary>
/// Returns True if input arrays are shape consistent and all elements equal.
///
/// Shape consistent means they are either the same shape, or one input array
/// can be broadcasted to create the same shape as the other one.
/// </summary>
/// <param name="a2">
/// Input arrays.
/// </param>
/// <param name="a1">
/// Input arrays.
/// </param>
/// <returns>
/// True if equivalent, False otherwise.
/// </returns>
public static bool array_equiv(NDarray a2, NDarray a1)
=> NumPy.Instance.array_equiv(a2, a1);
/// <summary>
/// Return the truth value of (x1 > x2) element-wise.
/// </summary>
/// <param name="x2">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </param>
/// <param name="x1">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </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, element-wise comparison of x1 and x2.
/// Typically of type bool, unless dtype=object is passed.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray greater(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.greater(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Return the truth value of (x1 >= x2) element-wise.
/// </summary>
/// <param name="x2">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </param>
/// <param name="x1">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </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, element-wise comparison of x1 and x2.
/// Typically of type bool, unless dtype=object is passed.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray<bool> greater_equal(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.greater_equal(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Return the truth value of (x1 < x2) element-wise.
/// </summary>
/// <param name="x2">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </param>
/// <param name="x1">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </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, element-wise comparison of x1 and x2.
/// Typically of type bool, unless dtype=object is passed.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray less(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.less(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Return the truth value of (x1 =< x2) element-wise.
/// </summary>
/// <param name="x2">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </param>
/// <param name="x1">
/// Input arrays. If x1.shape != x2.shape, they must be
/// broadcastable to a common shape (which may be the shape of one or
/// the other).
/// </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, element-wise comparison of x1 and x2.
/// Typically of type bool, unless dtype=object is passed.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray less_equal(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.less_equal(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Return (x1 == x2) element-wise.
/// </summary>
/// <param name="x2">
/// Input arrays of the same shape.
/// </param>
/// <param name="x1">
/// Input arrays of the same shape.
/// </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, element-wise comparison of x1 and x2.
/// Typically of type bool, unless dtype=object is passed.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray equal(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.equal(x2, x1, @out:@out, @where:@where);
/// <summary>
/// Return (x1 != x2) element-wise.
/// </summary>
/// <param name="x2">
/// Input arrays.
/// </param>
/// <param name="x1">
/// Input arrays.
/// </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, element-wise comparison of x1 and x2.
/// Typically of type bool, unless dtype=object is passed.
/// This is a scalar if both x1 and x2 are scalars.
/// </returns>
public static NDarray not_equal(NDarray x2, NDarray x1, NDarray @out = null, NDarray @where = null)
=> NumPy.Instance.not_equal(x2, x1, @out:@out, @where:@where);
}
}