arrayfire.arith module¶
Math functions (sin, sqrt, exp, etc).
arrayfire.arith.abs(a)[source]¶Find the absolute values.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
Contains the absolute values of the inputs.
arrayfire.arith.acos(a)[source]¶Arc Cosine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the arc cosine of each value froma.
arrayfire.arith.acosh(a)[source]¶Arc Hyperbolic Cosine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the arc hyperbolic cosine of each value froma.
arrayfire.arith.arg(a)[source]¶Find the theta value of the inputs in polar co-ordinates.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
Contains the theta values.
arrayfire.arith.asin(a)[source]¶Arc Sine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the arc sine of each value froma.
arrayfire.arith.asinh(a)[source]¶Arc Hyperbolic Sine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the arc hyperbolic sine of each value froma.
arrayfire.arith.atan(a)[source]¶Arc Tangent of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the arc tangent of each value froma.
arrayfire.arith.atan2(lhs,rhs)[source]¶Find the arc tan using two values.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
Contains the value arc tan values where:-lhs contains the sine values.-rhs contains the cosine values.
arrayfire.arith.atanh(a)[source]¶Arc Hyperbolic Tangent of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the arc hyperbolic tangent of each value froma.
arrayfire.arith.cast(a,dtype)[source]¶Cast an array to a specified type
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- dtype: af.Dtype
- Must be one of the following:
Dtype.f32 for float
Dtype.f64 for double
Dtype.b8 for bool
Dtype.u8 for unsigned char
Dtype.s32 for signed 32 bit integer
Dtype.u32 for unsigned 32 bit integer
Dtype.s64 for signed 64 bit integer
Dtype.u64 for unsigned 64 bit integer
Dtype.c32 for 32 bit complex number
Dtype.c64 for 64 bit complex number
- Returns
- ——–
- outaf.Array
array containing the values froma after converting todtype.
arrayfire.arith.cbrt(a)[source]¶Cube root of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the cube root of each value froma.
arrayfire.arith.ceil(a)[source]¶Round the values towards a bigger integer.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the ceiled values.
arrayfire.arith.clamp(val,low,high)[source]¶Clamp the input value between low and high
- Parameters
- valaf.Array
Multi dimensional arrayfire array to be clamped.
- lowaf.Array or scalar
Multi dimensional arrayfire array or a scalar number denoting the lower value(s).
- highaf.Array or scalar
Multi dimensional arrayfire array or a scalar number denoting the higher value(s).
arrayfire.arith.conjg(a)[source]¶Find the complex conjugate values of the input.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing copmplex conjugate values froma.
arrayfire.arith.cos(a)[source]¶Cosine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the cosine of each value froma.
arrayfire.arith.cosh(a)[source]¶Hyperbolic Cosine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the hyperbolic cosine of each value froma.
arrayfire.arith.cplx(lhs,rhs=None)[source]¶Create a complex array from real inputs.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsoptional: af.Array or scalar. default: None.
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
Contains complex values whose- real values contain values fromlhs- imaginary values contain values fromrhs (0 ifrhs is None)
arrayfire.arith.erf(a)[source]¶Error function of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the error function of each value froma.
arrayfire.arith.erfc(a)[source]¶Complementary error function of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the complementary error function of each value froma.
arrayfire.arith.exp(a)[source]¶Exponential of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the exponential of each value froma.
arrayfire.arith.expm1(a)[source]¶Exponential of each element in the array minus 1.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the exponential of each value froma.
arrayfire.arith.factorial(a)[source]¶factorial of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the factorial of each value froma.
arrayfire.arith.floor(a)[source]¶Round the values towards a smaller integer.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the floored values.
arrayfire.arith.hypot(lhs,rhs)[source]¶Find the value of the hypotunese.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
Contains the value ofsqrt(lhs**2, rhs**2).
arrayfire.arith.imag(a)[source]¶Find the imaginary values of the input.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the imaginary values froma.
arrayfire.arith.isinf(a)[source]¶Check if each element of the input is infinity.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the output after checking if each value ofa is inifnite.
arrayfire.arith.isnan(a)[source]¶Check if each element of the input is NaN.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the output after checking if each value ofa is NaN.
arrayfire.arith.iszero(a)[source]¶Check if each element of the input is zero.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the output after checking if each value ofa is 0.
arrayfire.arith.lgamma(a)[source]¶Performs the logarithm of gamma function for each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the output of logarithm of gamma function of each value froma.
arrayfire.arith.log(a)[source]¶Natural logarithm of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the natural logarithm of each value froma.
arrayfire.arith.log10(a)[source]¶Logarithm base 10 of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the logarithm base 10 of each value froma.
arrayfire.arith.log1p(a)[source]¶Logarithm of each element in the array plus 1.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the the values oflog(a) + 1
arrayfire.arith.log2(a)[source]¶Logarithm base 2 of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the logarithm base 2 of each value froma.
arrayfire.arith.maxof(lhs,rhs)[source]¶Find the maximum value of two inputs at each location.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
array containing the maximum value at each location of the inputs.
arrayfire.arith.minof(lhs,rhs)[source]¶Find the minimum value of two inputs at each location.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
array containing the minimum value at each location of the inputs.
arrayfire.arith.mod(lhs,rhs)[source]¶Find the modulus.Parameters———-lhs : af.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- outaf.Array
Contains the moduli after dividing each value of lhs` with those inrhs.
Atleast one oflhs andrhs needs to be af.Array.
Iflhs andrhs are both af.Array, they must be of same size.
arrayfire.arith.pow(lhs,rhs)[source]¶Find the power of two inputs at each location.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
array containing the value oflhs ** (rhs)
arrayfire.arith.pow2(a)[source]¶Raise 2 to the power of each element in input.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array where each element is 2 raised to power of the corresponding value froma.
arrayfire.arith.real(a)[source]¶Find the real values of the input.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the real values froma.
arrayfire.arith.rem(lhs,rhs)[source]¶Find the remainder.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
Contains the remainders after dividing each value of lhs` with those inrhs.
arrayfire.arith.root(lhs,rhs)[source]¶Find the root values of two inputs at each location.
- Parameters
- lhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- rhsaf.Array or scalar
Multi dimensional arrayfire array or a scalar number.
- Returns
- outaf.Array
array containing the value oflhs ** (1/rhs)
arrayfire.arith.round(a)[source]¶Round the values to nearest integer.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the values rounded to nearest integer.
arrayfire.arith.rsqrt(a)[source]¶Reciprocal or inverse square root of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the inverse square root of each value froma.
arrayfire.arith.sigmoid(a)[source]¶Raise 2 to the power of each element in input.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array where each element is outout of a sigmoid function for the corresponding value froma.
arrayfire.arith.sign(a)[source]¶Find the sign of the inputs.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing 1 for negative values, 0 otherwise.
arrayfire.arith.sin(a)[source]¶Sine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the sine of each value froma.
arrayfire.arith.sinh(a)[source]¶Hyperbolic Sine of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the hyperbolic sine of each value froma.
arrayfire.arith.sqrt(a)[source]¶Square root of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the square root of each value froma.
arrayfire.arith.tan(a)[source]¶Tangent of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the tangent of each value froma.
arrayfire.arith.tanh(a)[source]¶Hyperbolic Tangent of each element in the array.
- Parameters
- aaf.Array
Multi dimensional arrayfire array.
- Returns
- outaf.Array
array containing the hyperbolic tangent of each value froma.
