arith.h
Go to the documentation of this file.
1 /*******************************************************
2  * Copyright (c) 2014, ArrayFire
3  * All rights reserved.
4  *
5  * This file is distributed under 3-clause BSD license.
6  * The complete license agreement can be obtained at:
7  * http://arrayfire.com/licenses/BSD-3-Clause
8  ********************************************************/
9 
10 #include <af/defines.h>
11 
12 #ifdef __cplusplus
13 namespace af
14 {
15  class array;
16 
25  AFAPI array min (const array &lhs, const array &rhs);
26 
28  AFAPI array min (const array &lhs, const double rhs);
29 
31  AFAPI array min (const double lhs, const array &rhs);
33 
41  AFAPI array max (const array &lhs, const array &rhs);
42 
44  AFAPI array max (const array &lhs, const double rhs);
45 
47  AFAPI array max (const double lhs, const array &rhs);
49 
58  AFAPI array rem (const array &lhs, const array &rhs);
59 
61  AFAPI array rem (const array &lhs, const double rhs);
62 
64  AFAPI array rem (const double lhs, const array &rhs);
66 
75  AFAPI array mod (const array &lhs, const array &rhs);
76 
78  AFAPI array mod (const array &lhs, const double rhs);
79 
81  AFAPI array mod (const double lhs, const array &rhs);
83 
90  AFAPI array abs (const array &in);
91 
100  AFAPI array arg (const array &in);
101 
112  AFAPI array sign (const array &in);
113 
122  AFAPI array round (const array &in);
123 
132  AFAPI array trunc (const array &in);
133 
134 
141  AFAPI array floor (const array &in);
142 
149  AFAPI array ceil (const array &in);
150 
161  AFAPI array hypot (const array &lhs, const array &rhs);
162 
164  AFAPI array hypot (const array &lhs, const double rhs);
165 
167  AFAPI array hypot (const double lhs, const array &rhs);
169 
176  AFAPI array sin (const array &in);
177 
184  AFAPI array cos (const array &in);
185 
192  AFAPI array tan (const array &in);
193 
200  AFAPI array asin (const array &in);
201 
208  AFAPI array acos (const array &in);
209 
216  AFAPI array atan (const array &in);
217 
225  AFAPI array atan2 (const array &lhs, const array &rhs);
226 
228  AFAPI array atan2 (const array &lhs, const double rhs);
229 
231  AFAPI array atan2 (const double lhs, const array &rhs);
233 
246  AFAPI array complex(const array &lhs, const array &rhs);
247 
249  AFAPI array complex(const array &lhs, const double rhs);
250 
252  AFAPI array complex(const double lhs, const array &rhs);
253 
260  AFAPI array complex(const array &in);
262 
269  AFAPI array real (const array &in);
270 
277  AFAPI array imag (const array &in);
278 
285  AFAPI array conjg (const array &in);
286 
293  AFAPI array sinh (const array &in);
294 
301  AFAPI array cosh (const array &in);
302 
309  AFAPI array tanh (const array &in);
310 
317  AFAPI array asinh (const array &in);
318 
325  AFAPI array acosh (const array &in);
326 
333  AFAPI array atanh (const array &in);
334 
342  AFAPI array root (const array &lhs, const array &rhs);
343 
351  AFAPI array root (const array &lhs, const double rhs);
352 
360  AFAPI array root (const double lhs, const array &rhs);
361 
362 
373  AFAPI array pow (const array &lhs, const array &rhs);
374 
376  AFAPI array pow (const array &lhs, const double rhs);
377 
379  AFAPI array pow (const double lhs, const array &rhs);
380 
386  AFAPI array pow2 (const array &in);
388 
389 
396  AFAPI array exp (const array &in);
397 
405  AFAPI array expm1 (const array &in);
406 
413  AFAPI array erf (const array &in);
414 
421  AFAPI array erfc (const array &in);
422 
429  AFAPI array log (const array &in);
430 
438  AFAPI array log1p (const array &in);
439 
446  AFAPI array log10 (const array &in);
447 
454  AFAPI array log2 (const array &in);
455 
462  AFAPI array sqrt (const array &in);
463 
470  AFAPI array cbrt (const array &in);
471 
479  AFAPI array factorial (const array &in);
480 
487  AFAPI array tgamma (const array &in);
488 
495  AFAPI array lgamma (const array &in);
496 
503  AFAPI array iszero (const array &in);
504 
511  AFAPI array isInf (const array &in);
512 
519  AFAPI array isNaN (const array &in);
520 }
521 #endif
522 
523 #ifdef __cplusplus
524 extern "C" {
525 #endif
526 
538  AFAPI af_err af_add (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
539 
551  AFAPI af_err af_sub (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
552 
564  AFAPI af_err af_mul (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
565 
577  AFAPI af_err af_div (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
578 
590  AFAPI af_err af_lt (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
591 
603  AFAPI af_err af_gt (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
604 
616  AFAPI af_err af_le (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
617 
629  AFAPI af_err af_ge (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
630 
642  AFAPI af_err af_eq (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
643 
655  AFAPI af_err af_neq (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
656 
668  AFAPI af_err af_and (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
669 
681  AFAPI af_err af_or (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
682 
692  AFAPI af_err af_not (af_array *out, const af_array in);
693 
705  AFAPI af_err af_bitand (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
706 
718  AFAPI af_err af_bitor (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
719 
731  AFAPI af_err af_bitxor (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
732 
744  AFAPI af_err af_bitshiftl(af_array *out, const af_array lhs, const af_array rhs, const bool batch);
745 
757  AFAPI af_err af_bitshiftr(af_array *out, const af_array lhs, const af_array rhs, const bool batch);
758 
769  AFAPI af_err af_cast (af_array *out, const af_array in, const af_dtype type);
770 
782  AFAPI af_err af_minof (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
783 
795  AFAPI af_err af_maxof (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
796 
808  AFAPI af_err af_rem (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
809 
821  AFAPI af_err af_mod (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
822 
832  AFAPI af_err af_abs (af_array *out, const af_array in);
833 
843  AFAPI af_err af_arg (af_array *out, const af_array in);
844 
856  AFAPI af_err af_sign (af_array *out, const af_array in);
857 
869  AFAPI af_err af_round (af_array *out, const af_array in);
870 
880  AFAPI af_err af_trunc (af_array *out, const af_array in);
881 
891  AFAPI af_err af_floor (af_array *out, const af_array in);
892 
902  AFAPI af_err af_ceil (af_array *out, const af_array in);
903 
915  AFAPI af_err af_hypot (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
916 
926  AFAPI af_err af_sin (af_array *out, const af_array in);
927 
937  AFAPI af_err af_cos (af_array *out, const af_array in);
938 
948  AFAPI af_err af_tan (af_array *out, const af_array in);
949 
959  AFAPI af_err af_asin (af_array *out, const af_array in);
960 
970  AFAPI af_err af_acos (af_array *out, const af_array in);
971 
981  AFAPI af_err af_atan (af_array *out, const af_array in);
982 
994  AFAPI af_err af_atan2 (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
995 
1007  AFAPI af_err af_cplx2 (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
1008 
1018  AFAPI af_err af_cplx (af_array *out, const af_array in);
1019 
1029  AFAPI af_err af_real (af_array *out, const af_array in);
1030 
1040  AFAPI af_err af_imag (af_array *out, const af_array in);
1041 
1051  AFAPI af_err af_conjg (af_array *out, const af_array in);
1052 
1062  AFAPI af_err af_sinh (af_array *out, const af_array in);
1063 
1073  AFAPI af_err af_cosh (af_array *out, const af_array in);
1074 
1084  AFAPI af_err af_tanh (af_array *out, const af_array in);
1085 
1095  AFAPI af_err af_asinh (af_array *out, const af_array in);
1096 
1106  AFAPI af_err af_acosh (af_array *out, const af_array in);
1107 
1117  AFAPI af_err af_atanh (af_array *out, const af_array in);
1118 
1130  AFAPI af_err af_root (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
1131 
1132 
1144  AFAPI af_err af_pow (af_array *out, const af_array lhs, const af_array rhs, const bool batch);
1145 
1155  AFAPI af_err af_pow2 (af_array *out, const af_array in);
1156 
1166  AFAPI af_err af_exp (af_array *out, const af_array in);
1167 
1177  AFAPI af_err af_expm1 (af_array *out, const af_array in);
1178 
1188  AFAPI af_err af_erf (af_array *out, const af_array in);
1189 
1199  AFAPI af_err af_erfc (af_array *out, const af_array in);
1200 
1210  AFAPI af_err af_log (af_array *out, const af_array in);
1211 
1221  AFAPI af_err af_log1p (af_array *out, const af_array in);
1222 
1232  AFAPI af_err af_log10 (af_array *out, const af_array in);
1233 
1243  AFAPI af_err af_log2 (af_array *out, const af_array in);
1244 
1254  AFAPI af_err af_sqrt (af_array *out, const af_array in);
1255 
1265  AFAPI af_err af_cbrt (af_array *out, const af_array in);
1266 
1276  AFAPI af_err af_factorial (af_array *out, const af_array in);
1277 
1287  AFAPI af_err af_tgamma (af_array *out, const af_array in);
1288 
1298  AFAPI af_err af_lgamma (af_array *out, const af_array in);
1299 
1309  AFAPI af_err af_iszero (af_array *out, const af_array in);
1310 
1320  AFAPI af_err af_isinf (af_array *out, const af_array in);
1321 
1331  AFAPI af_err af_isnan (af_array *out, const af_array in);
1332 #ifdef __cplusplus
1333 }
1334 #endif
AFAPI af_err af_log2(af_array *out, const af_array in)
C Interface for logarithm base 2.
AFAPI af_err af_bitshiftl(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for left shift on integer arrays.
AFAPI array tgamma(const array &in)
C++ Interface for gamma function of input.
AFAPI array round(const array &in)
C++ Interface for rounding an array of numbers.
AFAPI array pow2(const array &in)
C++ Interface for power of 2.
AFAPI af_err af_mod(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for modulus.
AFAPI af_err af_cplx2(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for creating complex array from two input arrays.
AFAPI af_err af_bitshiftr(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for right shift on integer arrays.
Definition: algorithm.h:14
AFAPI af_err af_bitand(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for performing bitwise and on two arrays.
AFAPI array arg(const array &in)
C++ Interface for arg.
AFAPI array conjg(const array &in)
C++ Interface for getting the complex conjugate of input array.
AFAPI af_err af_log10(af_array *out, const af_array in)
C Interface for logarithm base 10.
AFAPI af_err af_floor(af_array *out, const af_array in)
C Interface for flooring an array of numbers.
AFAPI array log1p(const array &in)
C++ Interface for natural logarithm of 1 + input.
AFAPI af_err af_rem(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for remainder.
AFAPI array mod(const array &lhs, const array &rhs)
C++ Interface for modulus when dividend and divisor are arrays or one of them is scalar.
AFAPI af_err af_ceil(af_array *out, const af_array in)
C Interface for ceiling an array of numbers.
AFAPI array root(const array &lhs, const array &rhs)
C++ Interface for nth root.
AFAPI af_err af_sqrt(af_array *out, const af_array in)
C Interface for square root.
AFAPI af_err af_imag(af_array *out, const af_array in)
C Interface for getting imaginary part from complex array.
AFAPI af_err af_add(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for adding arrays.
AFAPI array erfc(const array &in)
C++ Interface for complementary error function value.
AFAPI af_err af_and(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for performing logical and on two arrays.
AFAPI af_err af_pow(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for power.
AFAPI array acos(const array &in)
C++ Interface for arc cos (cos inverse)
AFAPI af_err af_asinh(af_array *out, const af_array in)
C Interface for asinh.
AFAPI af_err af_expm1(af_array *out, const af_array in)
C Interface for exponential of an array minus 1.
AFAPI array erf(const array &in)
C++ Interface for error function value.
AFAPI af_err af_le(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for checking if an array is less or equal to another.
AFAPI af_err af_mul(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for multiplying two arrays.
AFAPI array log10(const array &in)
C++ Interface for logarithm base 10.
AFAPI af_err af_bitxor(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for performing bitwise xor on two arrays.
AFAPI af_err af_sin(af_array *out, const af_array in)
C Interface for sin.
AFAPI af_err af_trunc(af_array *out, const af_array in)
C Interface for truncating an array of numbers.
AFAPI af_err af_sub(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for subtracting an array from another.
AFAPI array trunc(const array &in)
C++ Interface for truncating an array of numbers.
AFAPI array log2(const array &in)
C++ Interface for logarithm base 2.
AFAPI af_err af_arg(af_array *out, const af_array in)
C Interface for finding the phase.
AFAPI af_err af_round(af_array *out, const af_array in)
C Interface for rounding an array of numbers.
AFAPI array asin(const array &in)
C++ Interface for arc sin (sin inverse)
AFAPI af_err af_sinh(af_array *out, const af_array in)
C Interface for sinh.
AFAPI af_err af_exp(af_array *out, const af_array in)
C Interface for exponential of an array.
AFAPI af_err af_erfc(af_array *out, const af_array in)
C Interface for complementary error function value.
AFAPI af_err af_log(af_array *out, const af_array in)
C Interface for natural logarithm.
AFAPI af_err af_atan2(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for arc tan of two inputs.
AFAPI array hypot(const array &lhs, const array &rhs)
C++ Interface for getting length of hypotenuse of two inputs.
AFAPI af_err af_cplx(af_array *out, const af_array in)
C Interface for creating complex array from real array.
AFAPI array lgamma(const array &in)
C++ Interface for logarithm of absolute value of gamma function of input.
AFAPI af_err af_isinf(af_array *out, const af_array in)
C Interface for checking if values are infinities.
AFAPI af_err af_lt(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for checking if an array is less than another.
AFAPI af_err af_hypot(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for getting length of hypotenuse of two arrays.
AFAPI af_err af_acosh(af_array *out, const af_array in)
C Interface for acosh.
AFAPI array floor(const array &in)
C++ Interface for flooring an array of numbers.
AFAPI af_err af_div(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for dividing an array by another.
AFAPI array complex(const array &lhs, const array &rhs)
C++ Interface for creating complex array from two inputs.
AFAPI array log(const array &in)
C++ Interface for natural logarithm.
AFAPI array expm1(const array &in)
C++ Interface for exponential of an array minus 1.
AFAPI array tan(const array &in)
C++ Interface for tan.
af_err
Definition: defines.h:58
AFAPI af_err af_ge(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for checking if an array is greater or equal to another.
AFAPI af_err af_sign(af_array *out, const af_array in)
C Interface for finding the sign of the input.
AFAPI af_err af_atan(af_array *out, const af_array in)
C Interface for arc tan.
AFAPI af_err af_eq(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for checking if an array is equal to another.
AFAPI af_err af_real(af_array *out, const af_array in)
C Interface for getting real part from complex array.
AFAPI af_err af_root(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for root.
AFAPI af_err af_factorial(af_array *out, const af_array in)
C Interface for the factorial.
AFAPI af_err af_neq(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for checking if an array is not equal to another.
AFAPI af_err af_cosh(af_array *out, const af_array in)
C Interface for cosh.
AFAPI array atan2(const array &lhs, const array &rhs)
C++ Interface for arc tan of two arrays.
AFAPI array cbrt(const array &in)
C++ Interface for cube root of input.
AFAPI af_err af_atanh(af_array *out, const af_array in)
C Interface for atanh.
AFAPI array atan(const array &in)
C++ Interface for arc tan (tan inverse)
AFAPI array max(const array &in, const int dim=-1)
C++ Interface for maximum values in an array.
AFAPI af_err af_log1p(af_array *out, const af_array in)
C Interface for logarithm of (in + 1)
AFAPI array imag(const array &in)
C++ Interface for getting imaginary part from complex array.
AFAPI af_err af_lgamma(af_array *out, const af_array in)
C Interface for the logarithm of absolute values of gamma function.
AFAPI af_err af_erf(af_array *out, const af_array in)
C Interface for error function value.
AFAPI af_err af_asin(af_array *out, const af_array in)
C Interface for arc sin.
AFAPI array real(const array &in)
C++ Interface for getting real part from complex array.
AFAPI af_err af_pow2(af_array *out, const af_array in)
C Interface for power of two.
AFAPI af_err af_iszero(af_array *out, const af_array in)
C Interface for checking if values are zero.
AFAPI af_err af_gt(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for checking if an array is greater than another.
#define AFAPI
Definition: defines.h:31
AFAPI array rem(const array &lhs, const array &rhs)
C++ Interface for remainder when array divides array, scalar divides array or array divides scalar...
AFAPI array isNaN(const array &in)
C++ Interface for checking if values are NaNs.
AFAPI array isInf(const array &in)
C++ Interface for checking if values are Infinities.
AFAPI array cos(const array &in)
C++ Interface for cos.
AFAPI array abs(const array &in)
C++ Interface for absolute value.
AFAPI array sign(const array &in)
C++ Interface for getting the sign of input.
AFAPI array sinh(const array &in)
C++ Interface for sinh.
static af::array array(af::dim4 idims, cl_mem buf, af::dtype type, bool retain=false)
Create an af::array object from an OpenCL cl_mem buffer.
Definition: opencl.h:105
AFAPI af_err af_tan(af_array *out, const af_array in)
C Interface for tan.
AFAPI array asinh(const array &in)
C++ Interface for sinh inverse.
AFAPI array exp(const array &in)
C++ Interface for exponential of an array.
AFAPI array factorial(const array &in)
C++ Interface for factorial of input.
AFAPI array cosh(const array &in)
C++ Interface for cosh.
AFAPI af_err af_acos(af_array *out, const af_array in)
C Interface for arc cos.
AFAPI af_err af_minof(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for min of two arrays.
AFAPI af_err af_conjg(af_array *out, const af_array in)
C Interface for getting the complex conjugate of input array.
AFAPI array sqrt(const array &in)
C++ Interface for square root of input.
AFAPI af_err af_bitor(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for performing bitwise or on two arrays.
AFAPI af_err af_tgamma(af_array *out, const af_array in)
C Interface for the gamma function.
AFAPI af_err af_cbrt(af_array *out, const af_array in)
C Interface for cube root.
void * af_array
Definition: defines.h:172
AFAPI af_err af_maxof(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for max of two arrays.
AFAPI af_err af_isnan(af_array *out, const af_array in)
C Interface for checking if values are NaNs.
AFAPI af_err af_cos(af_array *out, const af_array in)
C Interface for cos.
AFAPI array min(const array &in, const int dim=-1)
C++ Interface for minimum values in an array.
AFAPI array acosh(const array &in)
C++ Interface for cosh inverse.
AFAPI array atanh(const array &in)
C++ Interface for tanh inverse.
AFAPI af_err af_cast(af_array *out, const af_array in, const af_dtype type)
C Interface for casting an array from one type to another.
AFAPI array tanh(const array &in)
C++ Interface for tanh.
AFAPI af_err af_tanh(af_array *out, const af_array in)
C Interface for tanh.
AFAPI af_err af_abs(af_array *out, const af_array in)
C Interface for absolute value.
AFAPI af_err af_not(af_array *out, const af_array in)
C Interface for performing logical not on input.
af_dtype
Definition: defines.h:151
AFAPI array ceil(const array &in)
C++ Interface for ceiling an array of numbers.
AFAPI array pow(const array &lhs, const array &rhs)
C++ Interface for power.
AFAPI array sin(const array &in)
C++ Interface for sin.
AFAPI array iszero(const array &in)
C++ Interface for checking if values are zero.
AFAPI af_err af_or(af_array *out, const af_array lhs, const af_array rhs, const bool batch)
C Interface for performing logical or on two arrays.