Functions

Documentation grouped according to category:

[detail level 12345]

ArrayFire Functions
sin	Perform a element-wise sin
sin	Perform a element-wise sin.
sinh	Performs an element-wise sinh
sinh	Performs an element-wise sinh.
asin	Performs an element-wise asin
asin	Performs an element-wise asin. array_func_asin
asinh	Performs an element-wise asinh
asinh	Performs an element-wise asinh.
cos	Perform a element-wise cos
cos	Perform a element-wise cos.
cosh	Performs an element-wise cosh
cosh	Performs an element-wise cosh.
acos	Performs an element-wise acos
acos	Performs an element-wise acos.
acosh	Performs an element-wise acosh
acosh	Performs an element-wise acosh.
tan	Perform a element-wise tan
tan	Perform a element-wise tan.
tanh	Performs an element-wise tanh
tanh	Performs an element-wise tanh.
atan	Performs an element-wise atan
atan	Performs an element-wise atan.
atanh	Performs an element-wise atanh
atanh	Performs an element-wise atanh.
isFinite	Checks if values are finite
isFinite	Checks if values are finite.
isInf	Checks if values are infinity
isInf	Checks if values are infinity.
isNaN	Checks if values are not a number
isNaN	Checks if values are not a number.
sign	Returns one(1) if positive negative one(-1) if negative
sign	Returns one(1) if positive negative one(-1) if negative.
sqrt	Computes the sqare root of the elements
sqrt	Computes the sqare root of the elements.
root	Computes the n-th root of the elements
root	Computes the n-th root of the elements.
pow2	Raises each element to a power of two(2)
pow2	Raises each element to a power of two(2)
ceil	Rounds each value up to the next integer
ceil	Rounds each value up to the next integer.
floor	Rounds each value down to the next integer
floor	Rounds each value down to the next integer.
trunc	Rounds to the nearest integer (towards zero)
trunc	Rounds to the nearest integer (towards zero).
factorial	Compute factorial
factorial	Compute factorial.
log	Computes logarithm of the elements
log	Computes logarithm of the elements.
log2	Compute logarithm to the base two(2)
log2	Compute logarithm to the base two(2).
log10	Compute logarithm to the base ten(10)
log10	Compute logarithm to the base ten(10).
log1p	Compute log(1+x) accurately for small values
log1p	Compute log(1+x) accurately for small values.
exp	Computes the exponential for each element
exp	Computes the exponential for each element.
expm1	Computes the exponential minus one(1) accurately for small values
expm1	Computes the exponential minus one(1) accurately for small values.
gamma	Computes the gamma function
gamma	Computes the gamma function.
gammaln	Computes the logarithm of a gamma function
gammaln	Computes the logarithm of a gamma function.
epsilon	Computes the epsilon
epsilon	Computes the epsilon.
erf	Computes the Gaussian error function
erf	Computes the Gaussian error function.
erfc	Computes the complex Gaussian error function
erfc	Computes the complex Gaussian error function.
erfinv	Computes the inverse Gaussian error function
erfinv	Computes the inverse Gaussian error function.
erfcinv	Computes the inverse complex Gaussian error function
erfcinv	Computes the inverse complex Gaussian error function.
abs	Computes the absolute value
abs	Computes the absolute value.
arg	Computes the phase angle in radians
arg	Computes the phase angle in radians.
conjg	Computes the complex conjugate
conjg	Computes the complex conjugate.
real	Extracts the real values
real	Extracts the real values.
imag	Extracts the imaginary values
imag	Extracts the imaginary values.
complex	Convert a real array into a complex array
complex	Convert a real array into a complex array.
atan2	Computes the arc tangent of two variables
atan2	Computes the arc tangent of two variables.
hypot	Computes the Euclidean distance function
hypot	Computes the Euclidean distance function.
rem	Computes the remainder
rem	Computes the remainder.
mod	Computes the mod
mod	Computes the mod.
lower	Extracts the lower triangular matrix
lower	Extracts the lower triangular matrix.
upper	Extracts the upper triangular matrix
upper	Extracts the upper triangular matrix.
diag	Extracts the diagonal of a matrix
diag	Extracts the upper triangular matrix.
join	Combines array along a dimension
join	Combines array along a dimension.
flip	Flips the values of an array
flip	Flips the values of an array.
sync	Block until all device operations have finished
sync	Block until all device operations have finished.
norm	Calculates the norm of a vector
norm	Calculate the norm of a vector
af_norm	Calculate the norm of a vector
dot	Calculate the dot product of a vector
dot	Calculate the dot product of a vector
af_dot/cublas_dot	C interface for Dot Product
matmul	Matrix multiplication using array
matmul	Perform a matrix multiplication on two matrices
af_matmul/af_gemm/cublas_gemm	C interface for Matrix Multiplication
sum	Sum elements in an array
sum	The C++ interface for sum
af_sum	C interface for sum
mul	Compute the product of elements of an array
mul	The C++ interface for mul
af_mul	C interface for mul
min	Compute the minimum value of an array
min	The C++ interface for min
af_min	C interface for min
max	Compute the maximum value of an array
max	The C++ interface for max
af_max	C interface for max
minmax	Computes the minimum and the maximum value of an array
minmax	The C++ interface for minmax
af_minmax	C interface for minmax
alltrue	Tests if all of the elements of an array are true
alltrue	The C++ interface for alltrue
af_alltrue	C interface for alltrue
anytrue	Tests if any of the elements are true
anytrue	The C++ interface for anytrue
af_anytrue	C interface for anytrue
where	Gets the indicies of non-zero values
where	The C++ interface for where
af_where	The C++ interface for where
count	Gets the number of non-zero elements
count	The C++ interface for count
af_count	C interface for count
segsum	Calculates the Segmented Sum of a set of elements
segsum	The C++ interface for segsum
af_segsum	The C interface for segsum
accum	Accumulated Sum
accum	The C++ interface for accum
af_accum	The C interface for accum
setunique	Gets the unique elements of a set
setunique	The C++ interface for setunique
setunion	Creates a union of two sets
setunion	The C++ interface for setunion
setintersect	Gets the intersect of two sets
setintersect	The C++ interface for setintersect
mean	Gets the mean of a vector or a matrix
mean	The C++ interface for mean
var	Gets the variance along a dimension
var	The C++ interface for variance
cov	Gets the covariance of row observations
cov	The C++ interface for covariance
stdev	Gets the standard deviation
stdev	The C++ interface for standard deviation
median	Calculates the median
median	The C++ interface for median
corrcoef	Calculates the Correlation Coefficient
corrcoef	The C++ interface for Correlation Coefficient
gfor	Parallel loop iterations: gfor
local	Create local copy of variable for iteration
gfor	Do not use this function directly; see GFOR: Parallel For-Loops
resize	Enlarge or shrink an image
resize	The C++ interface for resize
af_resize	The C interface for resize
gaussiankernel	Create a gaussian kernel
gaussiankernel	Creates a Gaussian kernel
filter	Apply an arbitrary filter to an image
filter	The C++ interface for filter
medfilt	Apply a median filter to an image
medfilt	The C++ interface for medfilt
af_medfilt	The C interface for medfilt
minfilt	Apply a min filter to an image
minfilt	The C++ interface for minfilt
maxfilt	Apply a max filter to an image
maxfilt	The C++ interface for maxfilt
erode	Erode an image by a given mask
erode	The C++ interface for erode
af_erode	The C interface for erode
dilate	Dilate an image
dilate	The C++ interface for dilate
af_dilate	The C interface for dilate
transform	Affine 2D image transforms
transform	The C++ interface for affine transformation
rotate	Rotate an image by a given angle
rotate	The C++ interface for rotate
af_rotate	The C interface for rotate
translate	Translate image
translate	The C++ interface for translate
scale	Scale image
scale	The C++ interface for scale
skew	Skew image
skew	The C++ interface for skew
transform_coord	Homogeneous (affine) coordinate transformation
transform_coord	The C++ interface for affine coordinate transforms
af_transform_coord	The C interface for affine coordinate transforms
rotate_coord	Rotation wrapper for homogeneous (affine) coordinate transformation
rotate_coord	The C++ interface for rotate wrapper for affine transformations
bilateral	Apply a bilateral filter to an image
bilateral	The C++ interface for bilateral filtering
af_bilateral	The C interface for bilateral
meanshift	Apply a meanshift filter to an image
meanshift	The C++ interface for meanshift
af_meanshift	The C interface for meanshift
colorspace	Change the colorspace on an image
colorspace	The C++ interface for colorspace
histogram	Compute a histogram for an image or perform histogram equalization
histogram	The C++ interface for histogram
histequal	The C++ interface for histequal
af_histogram	The C interface for histogram
af_histequalize	The C interface for histogram equalization
regions	Label the connected components in a binary image
regions	The C++ interface for regions
af_regions	The C interface for regions
areas	Calculate the area of each numbered component in a label matrix
areas	The C++ interface for areas
centroids	Compute the centroid of each numbered component in a label matrix
centroids	The C++ interface for centroids
diff	Compute the difference along a dimension
diff	The C++ interface for diff
af_diff	The C interface for diff
grad	Compute the gradient of a matrix
grad	The C++ interface for grad
af_grad	The C interface for Gradient along a dimension
kron	Calculate the Kronecker product of two matrices
af_kronProd	The C interface for Kronecker product
bessel	Compute the Bessel function for each element of an array
af_bessel	The C interface for Bessel functions
moddim	Modify the dimensions of an array object
moddim	Modify dimensions of input array
tile	Tile (repeat) an array along a dimension
tile	The C++ interface for tile
af_tile	The C interface for tile
flat	Flatten an array into column vector
flat	Flatten the input array into a vector
shift	Shift the values of an array around dimension (wrap around)
shift	The C++ interface for shift
af_shift	The C interface for shift
af_shiftd	The C interface for shiftd
reorder	Reorder dimensions of array
reorder	The C++ interface for reorder
af_reorder	The C interface for reorder
sort	Sort an array or matrix along a dimension
sort	The C++ interface for sort
sortdim	The C++ interface for sortdim
af_sort	The C interface for sort
af_issorted	The C interface for issorted
af_sortrows	The C interface for sortrows
transpose	Transpose a matrix
T	Transpose on an array
H	Conjugate transpose on an array
af_transpose	Transpose a matrix.
fft	Apply the Fast Fourier Transform (FFT)
fft	C++ interface for Fast Fourier Transform
af_fft	C interface for Fast Fourier Transform
fft_info	Fast Fourier Transform Info Functions
fir	Apply a Finite Impulse Response (FIR) filter
fir	C++ interface for Finite Impulse Response
filter1D	C interface for Impulse Response
iir	Apply an Infinite Impulse Response (IIR) Filter
iir	C++ interface for Infinite Impulse Response
filter1D	C interface for Impulse Response
convolve	Performs a convolution
convolve	C++ interface for Convolution
af_conv	C interface for Convolution
approx	Interpolation in one or two dimensions
approx	C++ interface for Interpolation
af_approx	C interface for Interpolation
ArrayFire Utilities
print_	Prints values of the array
printdims_	Prints dimensions of the array
show	Prints values of the array
start	Start timer
start	Start timer.
stop	Return elapsed seconds since last start()
stop	Return elapsed seconds since last start()
timeit	Robust timing of a function
timeit	Robust timing of a function.
C++ Interface
Array Member Functions
Constructors
Operator Overloads
operator()	Indexing using the () operator
unary operator-	Performs an arithmetic negation on the array
operator!	Performs a logical negation on the array
operator+	Performs an element wise addition
operator	Performs an element wise multiplication
operator-	Performs an element wise subtraction
operator/	Performs an element wise division
operator%	Performs an element wise modulus
operator+=	Element wise addition
operator-=	Element wise subtraction
operator=	Element wise multiplication
operator/=	Element wise division
operator%=	Element wise addition
operator++	Element wise increment
operator--	Element wise decrement
operator&	Element wise logical AND
operator|	Element wise logical OR
operator^	Element wise logical XOR
operator==	Element wise comparison
operator!=	Element wise not equal
operator<	Element wise less then
operator<=	Element wise less then or equal to
operator>	Element wise greater then
operator>=	Element wise greater then or equal to
operator<<	Prints the array
Member Functions
dims	Returns the size and number of dimensions of the array objects
elements	Returns the number of elements in an array
nonzeros	Returns the number of the nonzero elements
ngfor	Returns the number of gfor tiles
bytes	Returns the memory allocated by the array
isempty	Checks if array contains any elements
isscalar	Checks if the array contains only one element
isvector	Checks if the array has only one dimension
iscolumn	Checks if the array has only one column
type	Returns the type of the array
iscomplex	Checks if the array is a complex type
issparse	Checks if the array is a sparse matrix
eval	Evaluate all expressions associated with the variable
eval	Evaluate all expressions associated with the variable.
unlock	Regain control of a device pointer after a call to device()
scalar	Returns the first element of the array
device	Returns a device pointer to the data
host	Returns a host pointer to the data
alloc	Allocates and returns a pointer to device memory
pinned	Allocates and returns a pointer to pinned host memory
free	Free data allocated by alloc() or returned from host()
T	Transpose on an array
H	Conjugate transpose on an array
as	Converts an array
Indexing
row/rows	Access one or more rows of an array
col/cols	Access one or more columns of an array
slice/slices	Access one or more slices of an array
operator()	Indexing using the () operator
Basic operations
Array allocation, initialization
Generate and fill Arrays	Generate constant or random values on the device of specified type
Element-wise arithmetic
sin	Perform a element-wise sin.
sinh	Performs an element-wise sinh.
asin	Performs an element-wise asin. array_func_asin
asinh	Performs an element-wise asinh.
cos	Perform a element-wise cos.
cosh	Performs an element-wise cosh.
acos	Performs an element-wise acos.
acosh	Performs an element-wise acosh.
tan	Perform a element-wise tan.
tanh	Performs an element-wise tanh.
atan	Performs an element-wise atan.
atanh	Performs an element-wise atanh.
isFinite	Checks if values are finite.
isInf	Checks if values are infinity.
isNaN	Checks if values are not a number.
sign	Returns one(1) if positive negative one(-1) if negative.
sqrt	Computes the sqare root of the elements.
root	Computes the n-th root of the elements.
pow2	Raises each element to a power of two(2)
pow
ceil	Rounds each value up to the next integer.
floor	Rounds each value down to the next integer.
round
trunc	Rounds to the nearest integer (towards zero).
factorial	Compute factorial.
min
max
log	Computes logarithm of the elements.
log2	Compute logarithm to the base two(2).
log10	Compute logarithm to the base ten(10).
log1p	Compute log(1+x) accurately for small values.
exp	Computes the exponential for each element.
expm1	Computes the exponential minus one(1) accurately for small values.
gamma	Computes the gamma function.
gammaln	Computes the logarithm of a gamma function.
epsilon	Computes the epsilon.
erf	Computes the Gaussian error function.
erfc	Computes the complex Gaussian error function.
erfinv	Computes the inverse Gaussian error function.
erfcinv	Computes the inverse complex Gaussian error function.
abs	Computes the absolute value.
arg	Computes the phase angle in radians.
conjg	Computes the complex conjugate.
real	Extracts the real values.
imag	Extracts the imaginary values.
complex	Convert a real array into a complex array.
atan2	Computes the arc tangent of two variables.
hypot	Computes the Euclidean distance function.
rem	Computes the remainder.
mod	Computes the mod.
Subscripted array indexing	Get or set part of an array
row/rows	Access one or more rows of an array
col/cols	Access one or more columns of an array
slice/slices	Access one or more slices of an array
operator()	Indexing using the () operator
operator=	Assignment operator
end	Reference last element in dimension
span	Reference the entire dimension
Array info (dimensions, type, complexity, ...)
dims	Returns the size and number of dimensions of the array objects
elements	Returns the number of elements in an array
nonzeros	Returns the number of the nonzero elements
ngfor	Returns the number of gfor tiles
bytes	Returns the memory allocated by the array
isempty	Checks if array contains any elements
isscalar	Checks if the array contains only one element
isvector	Checks if the array has only one dimension
isrow	Checks if the array has only one row
iscolumn	Checks if the array has only one column
type	Returns the type of the array
iscomplex	Checks if the array is a complex type
isreal	Checks if the array is a real type
issparse	Checks if the array is a sparse matrix
eval	Evaluate all expressions associated with the variable
eval	Evaluate all expressions associated with the variable.
unlock	Regain control of a device pointer after a call to device()
Array manipulation (transpose, join, tile, shift, ...)
T	Transpose on an array
H	Conjugate transpose on an array
as	Converts an array
lower	Extracts the lower triangular matrix.
upper	Extracts the upper triangular matrix.
diag	Extracts the upper triangular matrix.
join	Combines array along a dimension.
flip	Flips the values of an array.
sync	Block until all device operations have finished.
eval	Evaluate all expressions associated with the variable.
tile	The C++ interface for tile
flat	Flatten the input array into a vector
moddim	Modify dimensions of input array
shift	The C++ interface for shift
reorder	The C++ interface for reorder
Device memory management, access
scalar	Returns the first element of the array
device	Returns a device pointer to the data
host	Returns a host pointer to the data
alloc	Allocates and returns a pointer to device memory
pinned	Allocates and returns a pointer to pinned host memory
free	Free data allocated by alloc() or returned from host()
Parallelized loops: gfor	Do not use this function directly; see GFOR: Parallel For-Loops
gfor	Do not use this function directly; see GFOR: Parallel For-Loops
Device management
Visualizing data
Licensing	Checkout or query the availability of features, and load license files
Displaying variables
_print
printdims_	Prints dimensions of the array.
Data Analysis
Sum and Product values
sum	The C++ interface for sum
mul	The C++ interface for mul
Minimum and Maximum values
min	The C++ interface for min
max	The C++ interface for max
minmax	The C++ interface for minmax
Test if any/all true
alltrue	The C++ interface for alltrue
anytrue	The C++ interface for anytrue
Index or count nonzero elements
where	The C++ interface for where
Cumulative and segmented Sum
segsum	The C++ interface for segsum
accum	The C++ interface for accum
Statistics: average, median, variance, histogram, etc.
mean	The C++ interface for mean
var	The C++ interface for variance
cov	The C++ interface for covariance
stdev	The C++ interface for standard deviation
median	The C++ interface for median
corrcoef	The C++ interface for Correlation Coefficient
Gradient or grid construction
diff	The C++ interface for diff
grad	The C++ interface for grad
Set operations: union, unique, intersection, ...
setunique	The C++ interface for setunique
setunion	The C++ interface for setunion
setintersect	The C++ interface for setintersect
Sorting (vectors, columns, rows)
sort	The C++ interface for sort
sortdim	The C++ interface for sortdim
Histograms
histogram	The C++ interface for histogram
histequal	The C++ interface for histequal
Linear Algebra
Matrix multiply, dot product, BLAS
dot	Calculate the dot product of a vector
matmul	Perform a matrix multiplication on two matrices
Solving linear systems
Factorizations: LU, QR, Cholesky, singular values, eigenvalues, Hessenberg
Matrix Operations
norm	Calculate the norm of a vector
Image and Signal Processing
Morphing: erosion, dilation, ...
erode	The C++ interface for erode
dilate	The C++ interface for dilate
Image transformations
resize	The C++ interface for resize
transform	The C++ interface for affine transformation
rotate	The C++ interface for rotate
translate	The C++ interface for translate
scale	The C++ interface for scale
skew	The C++ interface for skew
Colorspace conversions
colorspace	The C++ interface for colorspace
Histograms
histogram	The C++ interface for histogram
histequal	The C++ interface for histequal
Signal filtering
fir	C++ interface for Finite Impulse Response
iir	C++ interface for Infinite Impulse Response
Connected components, labeling, centroids, ...
regions	The C++ interface for regions
areas	The C++ interface for areas
centroids	The C++ interface for centroids
Fourier transforms (1D, 2D, 3D)
fft	C++ interface for Fast Fourier Transform
fft_info	Fast Fourier Transform Info Functions
Image filtering & convolutions
filter	The C++ interface for filter
medfilt	The C++ interface for medfilt
minfilt	The C++ interface for minfilt
maxfilt	The C++ interface for maxfilt
bilateral	The C++ interface for bilateral filtering
meanshift	The C++ interface for meanshift
convolve	C++ interface for Convolution
Interpolation and rescaling
approx	C++ interface for Interpolation
Utility Image Functions
gaussiankernel	Creates a Gaussian kernel
loadimage	The C++ interface for loadimage
saveimage	The C++ interface for saveimage
Sparse Matrices
Generate Sparse Matrices	Requires ArrayFire Pro
Helper functions	Requires ArrayFire Pro
C Interface
Basic operations (Device Pointer Interface)
Random Number Generation
af_rand	The C interface for Random Number Generation
Transpose, Conjugate Transpose
Tiling, shifting and reordering
af_tile	The C interface for tile
af_shift	The C interface for shift
af_shiftd	The C interface for shiftd
af_reorder	The C interface for reorder
Device management
Sorting (rows, columns, vectors, based on keys)
af_sort	The C interface for sort
af_issorted	The C interface for issorted
af_sortrows	The C interface for sortrows
Licensing	Checkout or query the availability of features, and load license files
Visualizing data
Data Analysis (Device Pointer Interface)
Sum and Product values
af_sum	C interface for sum
af_mul	C interface for mul
Minimum and Maximum values
af_max	C interface for max
af_min	C interface for min
af_minmax	C interface for minmax
Test if any/all true
af_alltrue	C interface for alltrue
af_anytrue	C interface for anytrue
Count nonzero values
af_count	C interface for count
Locate indices of non zero elements
af_where	The C++ interface for where
Cumulative and segmented Sum
af_segsum	The C interface for segsum
af_accum	The C interface for accum
Linear Algebra (Device Pointer Interface)	Some functions may require ArrayFire Pro
Matrix multiply, dot product, BLAS
af_matmul/af_gemm/cublas_gemm	C interface for Matrix Multiplication
af_dot/cublas_dot	C interface for Dot Product
Solving linear systems	Integer powers of input matrix
Factorization: LU, QR, Cholesky, singular values, eigenvalues, Hessenberg	LU Decomposition done in place
Matrix Operations	Inverse of a given matrix
af_norm	Calculate the norm of a vector
Image and Signal Processing (Device Pointer Interface)
Erosion, Dilation, Binary image morphing
af_erode	The C interface for erode
af_dilate	The C interface for dilate
Image transformations
af_rotate	The C interface for rotate
af_resize	The C interface for resize
Colorspace conversions
Histograms
af_histogram	The C interface for histogram
af_histequalize	The C interface for histogram equalization
Signal filtering
filter1D	C interface for Impulse Response
Connected components, labeling, centroids, ...
af_regions	The C interface for regions
Fourier transforms (1D, 2D, 3D)
af_fft	C interface for Fast Fourier Transform
fft_info	Fast Fourier Transform Info Functions
Image filtering & convolutions
af_bilateral	The C interface for bilateral
af_meanshift	The C interface for meanshift
af_medfilt	The C interface for medfilt
af_conv	C interface for Convolution
Interpolation and rescaling
af_scale2D	C interface for Rescaling a matrix
af_approx	C interface for Interpolation
Mathematical Functions (Device Pointer Interface)
Cross Product
Kron Product
af_kronProd	The C interface for Kronecker product
Difference
af_diff	The C interface for diff
Gradient
af_grad	The C interface for Gradient along a dimension