ArrayFire Functions

Modules

 abs
 Absolute value.
 
 accum
 Cumulative sum (inclusive). Also known as a scan.
 
 acos
 Inverse cosine.
 
 acosh
 Inverse hyperbolic cosine.
 
 add
 
 allTrue
 Test if all values in an array are true.
 
 allTrueByKey
 Calculate if all values that share the same consecutive keys are true.
 
 alloc
 Allocate memory using the ArrayFire memory manager.
 
 allocHost
 Allocate memory on host.
 
 and
 Logical AND.
 
 anisotropicDiffusion
 Anisotropic Smoothing Filter.
 
 anyTrueByKey
 Calculate if any values that share the same consecutive keys are true.
 
 anytrue
 Calculate if any values in an array are true.
 
 approx1
 Interpolation across a single dimension.
 
 approx2
 Interpolation along two dimensions.
 
 arg
 Phase of a number in the complex plane.
 
 asin
 
 
 asinh
 
 
 assign
 Copy and write values in the locations specified by the sequences.
 
 atan/atan2
 
 
 atanh
 
 
 bilateral
 Bilateral Filter.
 
 bitand
 
 
 bitor
 
 
 bitshiftl
 
 
 bitshiftr
 
 
 bitxor
 
 
 canny
 Canny Edge Detector.
 
 cast
 
 cbrt
 
 
 ceil
 
 
 cholesky
 Perform Cholesky decomposition.
 
 col/cols
 Gets a reference of a col in a 2D af::array.
 
 colorSpace
 
 
 complex
 
 confidenceCC
 Segment image based on similar pixel characteristics.
 
 conjg
 
 constant
 Create a array from a scalar input value.
 
 convolve (Non-separable)
 Convolution Integral for any(one through three) dimensional data.
 
 convolve (Separable)
 Separable Convolution.
 
 convolve1
 Convolution Integral for one dimensional data.
 
 convolve2
 Convolution Integral for two dimensional data.
 
 convolve3
 Convolution Integral for three dimensional data.
 
 corrcoef
 
 
 cos
 
 
 cosh
 
 
 count
 
 
 countByKey
 
 cov
 
 
 deleteImageMem
 
 dense
 Returns a dense array from a sparse input.
 
 det
 Find the determinant of the input matrix.
 
 deviceInfo
 Gets the information about device and platform as strings.
 
 deviceMemInfo
 Memory manager related functions.
 
 diag
 Extract diagonal from a matrix when extract is set to true. Create a diagonal matrix from input array when extract is set to false.
 
 diff1
 
 
 diff2
 
 
 dilate
 Dilation(morphological operator) for images.
 
 dilate3d
 Dilation(morphological operator) for volumes.
 
 div
 
 dog
 Difference of Gaussians.
 
 dot
 Calculate the dot product of a vector.
 
 eq
 
 erf
 
 
 erfc
 
 
 erode
 Erosion(morphological operator) for images.
 
 erode3d
 Erosion(morphological operator) for volumes.
 
 exp
 
 expm1
 
 
 factorial
 
 
 fast
 FAST feature detector.
 
 features
 Lookup values of an array based on sequences and/or arrays.
 
 fft
 Fast Fourier Transform.
 
 fft2
 Fast Fourier Transform.
 
 fft3
 Fast Fourier Transform.
 
 fftC2R
 Complex to Real Fast Fourier Transform.
 
 fftR2C
 Real to Complex Fast Fourier Transform.
 
 fir
 This function implements a Finite Impulse Filter.
 
 flat
 Flatten the input to a single dimension.
 
 flip
 Flip the input along specified dimension.
 
 floor
 
 
 free
 Returns memory to ArrayFire's memory manager. The memory will return to the memory pool.
 
 freeHost
 Free memory allocated on host internally by ArrayFire.
 
 freePinned
 Free pinned memory allocated by ArrayFire's memory manager.
 
 gaussiankernel
 Creates a Gaussian Kernel.
 
 ge
 
 getActiveBackend
 Get's the backend enum for the active backend.
 
 getAvailableBackends
 Returns an integer indicating the backends loaded successfully.
 
 getBackendCount
 Get the number of backends whose libraries were successfully loaded.
 
 getBackendId
 Get's the backend enum for an array.
 
 getDefaultRandomEngine
 Returns the default random engine object.
 
 getDevice
 Get the current device ID.
 
 getDeviceCount
 Gets the number of compute devices on the system.
 
 getDeviceId
 Get's the id of the device an array was created on.
 
 getSeed
 Returns the seed for random number generation.
 
 gloh
 SIFT feature detector and GLOH descriptor extractor.
 
 grad
 
 gray2rgb
 
 
 gt
 
 hammingMatcher
 Hamming Matcher.
 
 harris
 Harris corner detector.
 
 histequal
 Histogram equalization of input image.
 
 histogram
 Histogram of input data.
 
 homography
 Homography Estimation.
 
 hsv2rgb
 
 
 hypot
 
 
 identity
 Create an identity array with diagonal values 1.
 
 ifft
 Fast Fourier Transform.
 
 ifft2
 Fast Fourier Transform.
 
 ifft3
 Fast Fourier Transform.
 
 iir
 This function implements a Infinite Impulse Filter.
 
 imag
 
 index
 Lookup values of an array based on sequences and/or arrays.
 
 info
 Display ArrayFire and device info.
 
 infoString
 Get af::info() as a string.
 
 inverse
 Invert a matrix.
 
 inverseDeconv
 Inverse Deconvolution.
 
 iota
 Create an sequence [0, dims.elements() - 1] and modify to specified dimensions dims and then tile it according to tile_dims.
 
 isDoubleAvailable
 Check if double precision support is available for specified device.
 
 isHalfAvailable
 Check if half(16-bit) precision floating point support is available for specified device.
 
 isImageIoAvailable
 
 isLAPACKAvailable
 Returns true is ArrayFire is compiled with LAPACK support.
 
 isNan
 
 
 isinf
 
 
 iszero
 
 
 iterativeDeconv
 Iterative Deconvolution.
 
 join
 Join up to 4 arrays along specified dimension.
 
 le
 
 lgamma
 
 
 loadImage
 
 loadImageMem
 
 log
 
 
 log10
 
 
 log1p
 
 
 lookup
 Lookup values of an array by indexing with another array.
 
 lower
 Create a lower triangular matrix from input array.
 
 lt
 
 lu
 Perform LU decomposition.
 
 matchTemplate
 Template Matching.
 
 matmul
 Matrix multiplication using array.
 
 max
 
 
 max
 
 maxByKey
 
 maxfilt
 Find maximum value from a window.
 
 mean
 
 
 meanshift
 Meanshift Filter.
 
 medfilt
 Median Filter.
 
 median
 
 
 min
 
 
 min
 
 minByKey
 
 minfilt
 Find minimum value from a window.
 
 mod
 
 
 moddims
 Modify the input dimensions without changing the data order.
 
 moments
 
 mul
 
 nearestNeighbour
 Determine the nearest neighbouring points to a given set of points.
 
 neg
 
 neq
 
 norm
 Find the norm of the input matrix.
 
 not
 
 operator()
 Gets a reference to a set of elements.
 
 operator(star)=
 Multiplies and assigns the value(s) of val to the elements of the af::array.
 
 operator+=
 Adds and assigns the value(s) of val to the elements of the af::array.
 
 operator-=
 Subtracts and assigns the value(s) of val to the elements of the af::array.
 
 operator/=
 Divides and assigns the value(s) of val to the elements of the af::array.
 
 operator=
 Assignes the value(s) of val to the elements of the af::array.
 
 or
 
 orb
 ORB Feature descriptor.
 
 pad
 Pad an array.
 
 pinned
 Allocate pinned memory using ArrayFire's memory manager.
 
 pinverse
 Pseudo-invert a matrix.
 
 pow
 
 
 print
 Print the array to screen.
 
 product
 
 
 productByKey
 
 qr
 Perform QR decomposition.
 
 randn
 Create a random array sampled from normal distribution.
 
 randomEngine
 Functions to create, modify, use, and destroy randomEngine objects.
 
 randu
 Create a random array sampled from uniform distribution.
 
 range
 Creates an array with [0, n] values along the seq_dim which is tiled across other dimensions.
 
 rank
 Find the rank of the input matrix.
 
 readArray
 Load an array from a file.
 
 real
 
 regions
 Find blobs in given image.
 
 rem
 
 
 reorder
 Reorder an array according to the specified dimensions.
 
 replace
 Replace elements of an array based on a conditional array.
 
 resize
 
 rgb2gray
 
 
 rgb2hsv
 
 
 rgb2ycbcr
 
 
 root
 
 
 rotate
 Rotate an input image or array.
 
 round
 
 
 row/rows
 Gets a reference of a row in a 2D af::array.
 
 rsqrt
 
 
 sat
 Summed Area Tables.
 
 saveArray
 Save an array to a binary file.
 
 saveImage
 
 saveImageMem
 
 scale
 
 scan
 
 scanByKey
 
 select
 Selects elements from two arrays based on the values of a binary conditional array.
 
 setBackend
 Set the current backend when using Unified backend.
 
 setDefaultRandomEngineType
 Set the default random engine type.
 
 setDevice
 Change current device to specified device.
 
 setSeed
 Set the seed for random number generation.
 
 setintersect
 
 setunion
 
 setunique
 
 shift
 Circular shift slong specified dimensions.
 
 sift
 SIFT feature detector and descriptor extractor.
 
 sign
 
 
 sin
 
 
 sinh
 
 
 skew
 
 slice/slices
 Gets a reference of a matrix in a 3D af::array.
 
 sobel
 Sobel Operators.
 
 solve
 Solve a system of equations.
 
 solveLU
 Solve a system of equations.
 
 sort
 
 sortByKey
 
 sortIndex
 
 sparse
 Create a sparse array.
 
 sparseConvertTo
 Convert an existing sparse array into a different storage format.
 
 sparseGetColdx
 Returns reference to the column indices component of the sparse array.
 
 sparseGetInfo
 Returns reference to components of the input sparse array.
 
 sparseGetNNZ
 Returns the number of non zero elements in the sparse array.
 
 sparseGetRowIdx
 Returns reference to the row indices component of the sparse array.
 
 sparseGetStorage
 Returns the storage type of a sparse array.
 
 sparseGetValues
 Returns reference to the values component of the sparse array.
 
 sqrt
 
 
 stdev
 
 
 sub
 
 sum
 
 
 sumByKey
 
 susan
 SUSAN corner detector.
 
 svd
 Computes the singular value decomposition of a matrix.
 
 sync
 Blocks until all operations on device are finished.
 
 tan/tan2
 
 
 tanh
 
 
 tgamma
 
 
 tile
 Repeat the contents of the input array along the specified dimensions.
 
 toString
 Print the array to a string instead of the screen.
 
 topk
 
 
 transform
 
 transformCoordinates
 
 translate
 
 transpose
 Matrix Transpose.
 
 trunc
 
 
 unwrap
 Rearrange windowed sections of an array into columns (or rows)
 
 upper
 Create a upper triangular matrix from input array.
 
 var
 
 
 where
 
 wrap
 
 ycbcr2rgb
 
 

Detailed Description