A high-performance general-purpose compute library
ArrayFire Functions

Topics

 abs
 
 
 accum
 
 
 acos
 
 
 acosh
 
 
 add
 
 
 allTrue
 
 
 allTrueByKey
 
 
 allocHost
 Allocate memory on host
 
 allocV2
 Allocate memory using the ArrayFire memory manager
 
 and
 
 
 anisotropicDiffusion
 Anisotropic Smoothing Filter
 
 anyTrueByKey
 
 
 anytrue
 
 
 approx1
 Interpolation across a single dimension
 
 approx2
 Interpolation along two dimensions
 
 arg
 
 
 asin
 
 
 asinh
 
 
 assign
 Copy and write values in the locations specified by the sequences
 
 atan/atan2
 
 
 atanh
 
 
 bilateral
 Bilateral Filter
 
 bitand
 
 
 bitnot
 
 
 bitor
 
 
 bitshiftl
 
 
 bitshiftr
 
 
 bitxor
 
 
 canny
 Canny Edge Detector
 
 cast
 
 
 cbrt
 
 
 ceil
 
 
 cholesky
 
 
 clamp
 
 
 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
 
 
 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
 
 
 deviceInfo
 Gets the information about device and platform as strings
 
 deviceMemInfo
 Memory manager related functions
 
 diag
 
 
 diff1
 
 
 diff2
 
 
 dilate
 Dilation(morphological operator) for images
 
 dilate3d
 Dilation(morphological operator) for volumes
 
 div
 
 
 dog
 Difference of Gaussians
 
 dot
 
 
 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
 
 
 flip
 
 
 floor
 
 
 freeHost
 Free memory allocated on host internally by ArrayFire
 
 freePinned
 Free pinned memory allocated by ArrayFire's memory manager
 
 freeV2
 Returns memory to ArrayFire's memory manager. The memory will return to the memory pool.
 
 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
 
 
 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
 
 
 infoString
 
 
 inverse
 
 
 inverseDeconv
 Inverse Deconvolution
 
 iota
 
 
 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 if ArrayFire is compiled with LAPACK support
 
 isinf
 
 
 isnan
 
 
 iszero
 
 
 iterativeDeconv
 Iterative Deconvolution
 
 join
 
 
 le
 
 
 lgamma
 
 
 loadImage
 
 
 loadImageMem
 
 
 log
 
 
 log10
 
 
 log1p
 
 
 log2
 
 
 lookup
 Lookup values of an array by indexing with another array.
 
 lower
 
 
 lt
 
 
 lu
 
 
 matchTemplate
 Template Matching
 
 matmul
 
 
 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
 
 
 moments
 
 
 mul
 
 
 nearestNeighbour
 Determine the nearest neighbouring points to a given set of points
 
 neg
 
 
 neq
 
 
 norm
 
 
 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
 
 
 pinned
 Allocate pinned memory using ArrayFire's memory manager.
 
 pinverse
 
 
 pow
 
 
 pow2
 
 
 print
 Print the array to screen
 
 product
 
 
 productByKey
 
 
 qr
 
 
 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
 
 
 rank
 
 
 readArray
 Load an array from a file
 
 real
 
 
 regions
 Find blobs in given image.
 
 rem
 
 
 reorder
 
 
 replace
 
 
 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
 
 
 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
 
 
 sift
 SIFT feature detector and descriptor extractor
 
 sigmoid
 Evaluate the logistical sigmoid function.
 
 sign
 
 
 sin
 
 
 sinh
 
 
 skew
 
 
 slice/slices
 Gets a reference of a matrix in a 3D af::array
 
 sobel
 Sobel Operators
 
 solve
 
 
 solveLU
 
 
 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
 
 
 sync
 Blocks until all operations on device are finished
 
 tan
 
 
 tanh
 
 
 tgamma
 
 
 tile
 
 
 toString
 Print the array to a string instead of the screen
 
 topk
 
 
 transform
 
 
 transformCoordinates
 
 
 translate
 
 
 transpose
 
 
 trunc
 
 
 unwrap
 Rearrange windowed sections of an array into columns (or rows)
 
 upper
 
 
 var
 
 
 where
 
 
 wrap
 
 
 ycbcr2rgb
 
 

Detailed Description