forked from arrayfire/arrayfire
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy patharith.dox
More file actions
611 lines (267 loc) · 7.33 KB
/
Copy patharith.dox
File metadata and controls
611 lines (267 loc) · 7.33 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
/*!
\page arith_real_only arith_real
\note This function supports real inputs only. Complex inputs are not yet supported.
*/
/*!
\page arith_int_only arith_int
\note This function supports integer only.
*/
/**
\addtogroup arrayfire_func
@{
\defgroup arith_func_add add
\ingroup arith_mat
Addition of two inputs.
\defgroup arith_func_sub sub
\ingroup arith_mat
Subtract one input from another
\defgroup arith_func_mul mul
\ingroup arith_mat
Multiply two inputs element wise
\defgroup arith_func_div div
\ingroup arith_mat
Divide one input by another
\defgroup arith_func_shiftl bitshiftl
\ingroup arith_mat
Left shift an input
\copydoc arith_int_only
\defgroup arith_func_shiftr bitshiftr
\ingroup arith_mat
Right shift an input
\copydoc arith_int_only
\defgroup arith_func_lt lt
\ingroup logic_mat
Check if input is less than another
\defgroup arith_func_gt gt
\ingroup logic_mat
Check if input is greater than another
\defgroup arith_func_le le
\ingroup logic_mat
Check if input is less than or equal to another
\defgroup arith_func_ge ge
\ingroup logic_mat
Check if input is greater than or equal to another
\defgroup arith_func_eq eq
\ingroup logic_mat
Check if input two inputs are equal
\defgroup arith_func_neq neq
\ingroup logic_mat
Check if input two inputs are not equal
\defgroup arith_func_and and
\ingroup logic_mat
Logical and of two inputs
\defgroup arith_func_or or
\ingroup logic_mat
Logical or of two inputs
\defgroup arith_func_not not
\ingroup logic_mat
Logical not of an input
\defgroup arith_func_neg neg
\ingroup numeric_mat
Negative of an input
\defgroup arith_func_bitand bitand
\ingroup logic_mat
Bitwise and operation of two inputs
\copydoc arith_int_only
\defgroup arith_func_bitor bitor
\ingroup logic_mat
Bitwise or operation of two inputs
\copydoc arith_int_only
\defgroup arith_func_bitxor bitxor
\ingroup logic_mat
Bitwise xor operation of two inputs
\copydoc arith_int_only
\defgroup arith_func_min min
\ingroup numeric_mat
Minimum of two inputs.
\defgroup arith_func_max max
\ingroup numeric_mat
Maximum of two inputs.
\defgroup arith_func_rem rem
\ingroup numeric_mat
Remainder operation
\copydoc arith_real_only
\defgroup arith_func_mod mod
\ingroup numeric_mat
Compute \f$x - n * y\f$ where n is quotient of \f$x / y\f$
\copydoc arith_real_only
\defgroup arith_func_abs abs
\ingroup numeric_mat
Absolute value
\defgroup arith_func_arg arg
\ingroup numeric_mat
Phase of a number in the complex plane
\defgroup arith_func_sign sign
\ingroup numeric_mat
Check if input is negative
\copydoc arith_real_only
\defgroup arith_func_round round
\ingroup numeric_mat
Round to nearest integer
\copydoc arith_real_only
\defgroup arith_func_trunc trunc
\ingroup numeric_mat
Truncate to nearest integer
\copydoc arith_real_only
\defgroup arith_func_floor floor
\ingroup numeric_mat
Round to integer less than equal to current value
\copydoc arith_real_only
\defgroup arith_func_ceil ceil
\ingroup numeric_mat
Round to integer greater than equal to current value
\copydoc arith_real_only
\defgroup arith_func_hypot hypot
\ingroup numeric_mat
Hypotenuse of the two inputs
\copydoc arith_real_only
\defgroup arith_func_sin sin
\ingroup trig_mat
sin of input
\copydoc arith_real_only
\defgroup arith_func_cos cos
\ingroup trig_mat
cos of input
\copydoc arith_real_only
\defgroup arith_func_tan tan/tan2
\ingroup trig_mat
tan of input
\copydoc arith_real_only
\defgroup arith_func_asin asin
\ingroup trig_mat
arc sin of input
\copydoc arith_real_only
\defgroup arith_func_acos acos
\ingroup trig_mat
arc cos of input
\copydoc arith_real_only
\defgroup arith_func_atan atan/atan2
\ingroup trig_mat
arc tan of input
\copydoc arith_real_only
\defgroup arith_func_sinh sinh
\ingroup hyper_mat
sinh of input
\copydoc arith_real_only
\defgroup arith_func_cosh cosh
\ingroup hyper_mat
cosh of input
\copydoc arith_real_only
\defgroup arith_func_tanh tanh
\ingroup hyper_mat
tanh of input
\copydoc arith_real_only
\defgroup arith_func_asinh asinh
\ingroup hyper_mat
asinh of input
\copydoc arith_real_only
\defgroup arith_func_acosh acosh
\ingroup hyper_mat
acosh of input
\copydoc arith_real_only
\defgroup arith_func_atanh atanh
\ingroup hyper_mat
atanh of input
\copydoc arith_real_only
\defgroup arith_func_cplx complex
\ingroup complex_mat
create complex arrays
\defgroup arith_func_real real
\ingroup complex_mat
Get real part of complex arrays
\defgroup arith_func_imag imag
\ingroup complex_mat
Get imaginary part of complex arrays
\defgroup arith_func_conjg conjg
\ingroup complex_mat
Get complex conjugate
\defgroup arith_func_root root
\ingroup explog_mat
Find root of an input
\copydoc arith_real_only
\defgroup arith_func_pow pow
\ingroup explog_mat
Raise an array to a power
If the input array has values beyond what a floating point type can represent, then there is no
guarantee that the results will be accurate. The exact type mapping from integral types to floating
point types used to compute power is given below.
| Input Type | Compute Type |
| :------------------| :--------------|
| unsigned long long | double |
| long long | double |
| unsigned int | double |
| int | double |
| unsigned short | float |
| short | float |
| unsigned char | float |
The output array will be of the same type as input.
\copydoc arith_real_only
\defgroup arith_func_exp exp
\ingroup explog_mat
Exponential of input
\defgroup arith_func_expm1 expm1
\ingroup explog_mat
Exponential of input - 1
\copydoc arith_real_only
\defgroup arith_func_erf erf
\ingroup explog_mat
Error function value
\copydoc arith_real_only
\defgroup arith_func_erfc erfc
\ingroup explog_mat
Complementary Error function value
\copydoc arith_real_only
\defgroup arith_func_log log
\ingroup explog_mat
Natural logarithm
\copydoc arith_real_only
\defgroup arith_func_log1p log1p
\ingroup explog_mat
Natural logarithm of (1 + in)
\copydoc arith_real_only
\defgroup arith_func_log10 log10
\ingroup explog_mat
logarithm base 10
\copydoc arith_real_only
\defgroup arith_func_sqrt sqrt
\ingroup explog_mat
Square root of input arrays
\copydoc arith_real_only
\defgroup arith_func_rsqrt rsqrt
\ingroup explog_mat
The reciprocal or inverse square root of input arrays
\f[ \frac{1}{\sqrt{x}} \f]
\copydoc arith_real_only
\defgroup arith_func_cbrt cbrt
\ingroup explog_mat
Cube root of input arrays
\copydoc arith_real_only
\defgroup arith_func_factorial factorial
\ingroup explog_mat
Factorial function
\copydoc arith_real_only
\defgroup arith_func_tgamma tgamma
\ingroup explog_mat
Gamma function
\copydoc arith_real_only
\defgroup arith_func_lgamma lgamma
\ingroup explog_mat
Logarithm of absolute values of Gamma function
\copydoc arith_real_only
\defgroup arith_func_iszero iszero
\ingroup helper_mat
Check if values are zero
\copydoc arith_real_only
\defgroup arith_func_isinf isinf
\ingroup helper_mat
Check if values are infinite
\copydoc arith_real_only
\defgroup arith_func_isnan isNan
\ingroup helper_mat
Check if values are Nan
\copydoc arith_real_only
\defgroup arith_func_cast cast
\ingroup helper_mat
Casting inputs from one type to another
@}
*/