defines.h File Reference

#include <af/compilers.h>
#include <stdbool.h>
#include <stdlib.h>
#include <af/version.h>

Go to the source code of this file.

Namespaces
namespace	af

Macros
#define	AFAPI   __attribute__((visibility("default")))
#define	SIZE_T_FRMT_SPECIFIER   "%zu"
#define	AF_DEPRECATED(msg)   __attribute__((deprecated))
#define	AF_MAX_DIMS   4

Typedefs
typedef long long	dim_t
typedef long long	intl
typedef unsigned long long	uintl
typedef void *	af_array
typedef af_dtype	dtype
typedef af_source	source
typedef af_interp_type	interpType
typedef af_border_type	borderType
typedef af_connectivity	connectivity
typedef af_match_type	matchType
typedef af_cspace_t	CSpace
typedef af_someenum_t	SomeEnum
typedef af_mat_prop	trans
typedef af_conv_mode	convMode
typedef af_conv_domain	convDomain
typedef af_mat_prop	matProp
typedef af_colormap	ColorMap
typedef af_norm_type	normType
typedef af_ycc_std	YCCStd
typedef af_image_format	imageFormat
typedef af_backend	Backend
typedef af_marker_type	markerType
typedef af_moment_type	momentType
typedef af_storage	storage
typedef af_binary_op	binaryOp
typedef af_random_engine_type	randomEngineType
typedef af_canny_threshold	cannyThreshold
typedef af_flux_function	fluxFunction
typedef af_diffusion_eq	diffusionEq
typedef af_topk_function	topkFunction
typedef af_var_bias	varBias
typedef af_iterative_deconv_algo	iterativeDeconvAlgo
typedef af_inverse_deconv_algo	inverseDeconvAlgo
typedef af_conv_gradient_type	convGradientType

Enumerations
enum	af_err {   AF_SUCCESS = 0 , AF_ERR_NO_MEM = 101 , AF_ERR_DRIVER = 102 , AF_ERR_RUNTIME = 103 ,   AF_ERR_INVALID_ARRAY = 201 , AF_ERR_ARG = 202 , AF_ERR_SIZE = 203 , AF_ERR_TYPE = 204 ,   AF_ERR_DIFF_TYPE = 205 , AF_ERR_BATCH = 207 , AF_ERR_DEVICE = 208 , AF_ERR_NOT_SUPPORTED = 301 ,   AF_ERR_NOT_CONFIGURED = 302 , AF_ERR_NONFREE = 303 , AF_ERR_NO_DBL = 401 , AF_ERR_NO_GFX = 402 ,   AF_ERR_NO_HALF = 403 , AF_ERR_LOAD_LIB = 501 , AF_ERR_LOAD_SYM = 502 , AF_ERR_ARR_BKND_MISMATCH = 503 ,   AF_ERR_INTERNAL = 998 , AF_ERR_UNKNOWN = 999 }
enum	af_dtype {   f32 , c32 , f64 , c64 ,   b8 , s32 , u32 , u8 ,   s64 , u64 , s16 , u16 ,   f16 }
enum	af_source { afDevice , afHost }
enum	af_interp_type {   AF_INTERP_NEAREST , AF_INTERP_LINEAR , AF_INTERP_BILINEAR , AF_INTERP_CUBIC ,   AF_INTERP_LOWER , AF_INTERP_LINEAR_COSINE , AF_INTERP_BILINEAR_COSINE , AF_INTERP_BICUBIC ,   AF_INTERP_CUBIC_SPLINE , AF_INTERP_BICUBIC_SPLINE }
enum	af_border_type { AF_PAD_ZERO = 0 , AF_PAD_SYM , AF_PAD_CLAMP_TO_EDGE , AF_PAD_PERIODIC }
enum	af_connectivity { AF_CONNECTIVITY_4 = 4 , AF_CONNECTIVITY_8 = 8 }
enum	af_conv_mode { AF_CONV_DEFAULT , AF_CONV_EXPAND }
enum	af_conv_domain { AF_CONV_AUTO , AF_CONV_SPATIAL , AF_CONV_FREQ }
enum	af_match_type {   AF_SAD = 0 , AF_ZSAD , AF_LSAD , AF_SSD ,   AF_ZSSD , AF_LSSD , AF_NCC , AF_ZNCC ,   AF_SHD }
enum	af_ycc_std { AF_YCC_601 = 601 , AF_YCC_709 = 709 , AF_YCC_2020 = 2020 }
enum	af_cspace_t { AF_GRAY = 0 , AF_RGB , AF_HSV , AF_YCbCr }
enum	af_mat_prop {   AF_MAT_NONE = 0 , AF_MAT_TRANS = 1 , AF_MAT_CTRANS = 2 , AF_MAT_CONJ = 4 ,   AF_MAT_UPPER = 32 , AF_MAT_LOWER = 64 , AF_MAT_DIAG_UNIT = 128 , AF_MAT_SYM = 512 ,   AF_MAT_POSDEF = 1024 , AF_MAT_ORTHOG = 2048 , AF_MAT_TRI_DIAG = 4096 , AF_MAT_BLOCK_DIAG = 8192 }
enum	af_norm_type {   AF_NORM_VECTOR_1 , AF_NORM_VECTOR_INF , AF_NORM_VECTOR_2 , AF_NORM_VECTOR_P ,   AF_NORM_MATRIX_1 , AF_NORM_MATRIX_INF , AF_NORM_MATRIX_2 , AF_NORM_MATRIX_L_PQ ,   AF_NORM_EUCLID = AF_NORM_VECTOR_2 }
enum	af_image_format {   AF_FIF_BMP = 0 , AF_FIF_ICO = 1 , AF_FIF_JPEG = 2 , AF_FIF_JNG = 3 ,   AF_FIF_PNG = 13 , AF_FIF_PPM = 14 , AF_FIF_PPMRAW = 15 , AF_FIF_TIFF = 18 ,   AF_FIF_PSD = 20 , AF_FIF_HDR = 26 , AF_FIF_EXR = 29 , AF_FIF_JP2 = 31 ,   AF_FIF_RAW = 34 }
enum	af_moment_type {   AF_MOMENT_M00 = 1 , AF_MOMENT_M01 = 2 , AF_MOMENT_M10 = 4 , AF_MOMENT_M11 = 8 ,   AF_MOMENT_FIRST_ORDER = AF_MOMENT_M00 | AF_MOMENT_M01 | AF_MOMENT_M10 | AF_MOMENT_M11 }
enum	af_homography_type { AF_HOMOGRAPHY_RANSAC = 0 , AF_HOMOGRAPHY_LMEDS = 1 }
enum	af_backend {   AF_BACKEND_DEFAULT = 0 , AF_BACKEND_CPU = 1 , AF_BACKEND_CUDA = 2 , AF_BACKEND_OPENCL = 4 ,   AF_BACKEND_ONEAPI = 8 }
enum	af_someenum_t { AF_ID = 0 }
enum	af_binary_op { AF_BINARY_ADD = 0 , AF_BINARY_MUL = 1 , AF_BINARY_MIN = 2 , AF_BINARY_MAX = 3 }
enum	af_random_engine_type {   AF_RANDOM_ENGINE_PHILOX_4X32_10 = 100 , AF_RANDOM_ENGINE_THREEFRY_2X32_16 = 200 , AF_RANDOM_ENGINE_MERSENNE_GP11213 = 300 , AF_RANDOM_ENGINE_PHILOX = AF_RANDOM_ENGINE_PHILOX_4X32_10 ,   AF_RANDOM_ENGINE_THREEFRY = AF_RANDOM_ENGINE_THREEFRY_2X32_16 , AF_RANDOM_ENGINE_MERSENNE = AF_RANDOM_ENGINE_MERSENNE_GP11213 , AF_RANDOM_ENGINE_DEFAULT = AF_RANDOM_ENGINE_PHILOX }
enum	af_colormap {   AF_COLORMAP_DEFAULT = 0 , AF_COLORMAP_SPECTRUM = 1 , AF_COLORMAP_COLORS = 2 , AF_COLORMAP_RED = 3 ,   AF_COLORMAP_MOOD = 4 , AF_COLORMAP_HEAT = 5 , AF_COLORMAP_BLUE = 6 , AF_COLORMAP_INFERNO = 7 ,   AF_COLORMAP_MAGMA = 8 , AF_COLORMAP_PLASMA = 9 , AF_COLORMAP_VIRIDIS = 10 }
enum	af_marker_type {   AF_MARKER_NONE = 0 , AF_MARKER_POINT = 1 , AF_MARKER_CIRCLE = 2 , AF_MARKER_SQUARE = 3 ,   AF_MARKER_TRIANGLE = 4 , AF_MARKER_CROSS = 5 , AF_MARKER_PLUS = 6 , AF_MARKER_STAR = 7 }
enum	af_canny_threshold { AF_CANNY_THRESHOLD_MANUAL = 0 , AF_CANNY_THRESHOLD_AUTO_OTSU = 1 }
enum	af_storage { AF_STORAGE_DENSE = 0 , AF_STORAGE_CSR = 1 , AF_STORAGE_CSC = 2 , AF_STORAGE_COO = 3 }
enum	af_flux_function { AF_FLUX_QUADRATIC = 1 , AF_FLUX_EXPONENTIAL = 2 , AF_FLUX_DEFAULT = 0 }
enum	af_diffusion_eq { AF_DIFFUSION_GRAD = 1 , AF_DIFFUSION_MCDE = 2 , AF_DIFFUSION_DEFAULT = 0 }
enum	af_topk_function {   AF_TOPK_MIN = 1 , AF_TOPK_MAX = 2 , AF_TOPK_STABLE = 4 , AF_TOPK_STABLE_MIN = AF_TOPK_STABLE | AF_TOPK_MIN ,   AF_TOPK_STABLE_MAX = AF_TOPK_STABLE | AF_TOPK_MAX , AF_TOPK_DEFAULT = 0 }
enum	af_var_bias { AF_VARIANCE_DEFAULT = 0 , AF_VARIANCE_SAMPLE = 1 , AF_VARIANCE_POPULATION = 2 }
enum	af_iterative_deconv_algo { AF_ITERATIVE_DECONV_LANDWEBER = 1 , AF_ITERATIVE_DECONV_RICHARDSONLUCY = 2 , AF_ITERATIVE_DECONV_DEFAULT = 0 }
enum	af_inverse_deconv_algo { AF_INVERSE_DECONV_TIKHONOV = 1 , AF_INVERSE_DECONV_DEFAULT = 0 }
enum	af_conv_gradient_type { AF_CONV_GRADIENT_DEFAULT = 0 , AF_CONV_GRADIENT_FILTER = 1 , AF_CONV_GRADIENT_DATA = 2 , AF_CONV_GRADIENT_BIAS = 3 }

Macro Definition Documentation

AF_DEPRECATED

#define AF_DEPRECATED

(

msg

)

__attribute__((deprecated))

Definition at line 44 of file defines.h.

AF_MAX_DIMS

#define AF_MAX_DIMS   4

Definition at line 237 of file defines.h.

AFAPI

#define AFAPI   __attribute__((visibility("default")))

Definition at line 38 of file defines.h.

SIZE_T_FRMT_SPECIFIER

#define SIZE_T_FRMT_SPECIFIER   "%zu"

Definition at line 40 of file defines.h.

Typedef Documentation

af_array

typedef void* af_array

Definition at line 240 of file defines.h.

dim_t

typedef long long dim_t

Definition at line 56 of file defines.h.

intl

typedef long long intl

Definition at line 62 of file defines.h.

uintl

typedef unsigned long long uintl

Definition at line 63 of file defines.h.

Enumeration Type Documentation

af_backend

enum af_backend

Enumerator
AF_BACKEND_DEFAULT	Default backend order: OpenCL -> CUDA -> CPU.
AF_BACKEND_CPU	CPU a.k.a sequential algorithms.
AF_BACKEND_CUDA	CUDA Compute Backend.
AF_BACKEND_OPENCL	OpenCL Compute Backend.
AF_BACKEND_ONEAPI	OneAPI Compute Backend.

Definition at line 413 of file defines.h.

             {
    AF_BACKEND_DEFAULT = 0,  
    AF_BACKEND_CPU     = 1,  
    AF_BACKEND_CUDA    = 2,  
    AF_BACKEND_OPENCL  = 4,  
    AF_BACKEND_ONEAPI  = 8   
} af_backend;

af_binary_op

enum af_binary_op

Enumerator
AF_BINARY_ADD
AF_BINARY_MUL
AF_BINARY_MIN
AF_BINARY_MAX

Definition at line 430 of file defines.h.

             {
    AF_BINARY_ADD  = 0,
    AF_BINARY_MUL  = 1,
    AF_BINARY_MIN  = 2,
    AF_BINARY_MAX  = 3
} af_binary_op;

af_border_type

enum af_border_type

Enumerator
AF_PAD_ZERO	Out of bound values are 0.
AF_PAD_SYM	Out of bound values are symmetric over the edge.
AF_PAD_CLAMP_TO_EDGE	Out of bound values are clamped to the edge.
AF_PAD_PERIODIC	Out of bound values are mapped to range of the dimension in cyclic fashion.

Definition at line 266 of file defines.h.

             {
    AF_PAD_ZERO = 0,
 
    AF_PAD_SYM,
 
    AF_PAD_CLAMP_TO_EDGE,
 
    AF_PAD_PERIODIC
} af_border_type;

af_canny_threshold

enum af_canny_threshold

Enumerator
AF_CANNY_THRESHOLD_MANUAL	User has to define canny thresholds manually.
AF_CANNY_THRESHOLD_AUTO_OTSU	Determine canny algorithm thresholds using Otsu algorithm.

Definition at line 483 of file defines.h.

             {
    AF_CANNY_THRESHOLD_MANUAL    = 0, 
    AF_CANNY_THRESHOLD_AUTO_OTSU = 1  
} af_canny_threshold;

af_colormap

enum af_colormap

Enumerator
AF_COLORMAP_DEFAULT	Default grayscale map.
AF_COLORMAP_SPECTRUM	Spectrum map (390nm-830nm, in sRGB colorspace)
AF_COLORMAP_COLORS	Colors, aka. Rainbow.
AF_COLORMAP_RED	Red hue map.
AF_COLORMAP_MOOD	Mood map.
AF_COLORMAP_HEAT	Heat map.
AF_COLORMAP_BLUE	Blue hue map.
AF_COLORMAP_INFERNO	Perceptually uniform shades of black-red-yellow.
AF_COLORMAP_MAGMA	Perceptually uniform shades of black-red-white.
AF_COLORMAP_PLASMA	Perceptually uniform shades of blue-red-yellow.
AF_COLORMAP_VIRIDIS	Perceptually uniform shades of blue-green-yellow.

Definition at line 454 of file defines.h.

             {
    AF_COLORMAP_DEFAULT = 0,    
    AF_COLORMAP_SPECTRUM= 1,    
    AF_COLORMAP_COLORS  = 2,    
    AF_COLORMAP_RED     = 3,    
    AF_COLORMAP_MOOD    = 4,    
    AF_COLORMAP_HEAT    = 5,    
    AF_COLORMAP_BLUE    = 6,    
    AF_COLORMAP_INFERNO = 7,    
    AF_COLORMAP_MAGMA   = 8,    
    AF_COLORMAP_PLASMA  = 9,    
    AF_COLORMAP_VIRIDIS = 10    
} af_colormap;

af_connectivity

enum af_connectivity

Enumerator
AF_CONNECTIVITY_4	Connectivity includes neighbors, North, East, South and West of current pixel.
AF_CONNECTIVITY_8	Connectivity includes 4-connectivity neigbors and also those on Northeast, Northwest, Southeast and Southwest.

Definition at line 288 of file defines.h.

             {
    AF_CONNECTIVITY_4 = 4,
 
    AF_CONNECTIVITY_8 = 8
} af_connectivity;

af_conv_domain

enum af_conv_domain

Enumerator
AF_CONV_AUTO	ArrayFire automatically picks the right convolution algorithm.
AF_CONV_SPATIAL	Perform convolution in spatial domain.
AF_CONV_FREQ	Perform convolution in frequency domain.

Definition at line 313 of file defines.h.

             {
    AF_CONV_AUTO,    
    AF_CONV_SPATIAL, 
    AF_CONV_FREQ     
} af_conv_domain;

af_conv_gradient_type

enum af_conv_gradient_type

Enumerator
AF_CONV_GRADIENT_DEFAULT
AF_CONV_GRADIENT_FILTER
AF_CONV_GRADIENT_DATA
AF_CONV_GRADIENT_BIAS

Definition at line 542 of file defines.h.

             {
    AF_CONV_GRADIENT_DEFAULT = 0,
    AF_CONV_GRADIENT_FILTER  = 1,
    AF_CONV_GRADIENT_DATA    = 2,
    AF_CONV_GRADIENT_BIAS    = 3
} af_conv_gradient_type;

af_conv_mode

enum af_conv_mode

Enumerator
AF_CONV_DEFAULT	Output of the convolution is the same size as input.
AF_CONV_EXPAND	Output of the convolution is signal_len + filter_len - 1.

Definition at line 300 of file defines.h.

             {
 
    AF_CONV_DEFAULT,
 
    AF_CONV_EXPAND
} af_conv_mode;

af_cspace_t

enum af_cspace_t

Enumerator
AF_GRAY	Grayscale.
AF_RGB	3-channel RGB
AF_HSV	3-channel HSV
AF_YCbCr	3-channel YCbCr

Definition at line 339 of file defines.h.

             {
    AF_GRAY = 0, 
    AF_RGB,      
    AF_HSV       
#if AF_API_VERSION >= 31
    , AF_YCbCr     
#endif
} af_cspace_t;

af_diffusion_eq

enum af_diffusion_eq

Enumerator
AF_DIFFUSION_GRAD	Gradient diffusion equation.
AF_DIFFUSION_MCDE	Modified curvature diffusion equation.
AF_DIFFUSION_DEFAULT	Default option is same as AF_DIFFUSION_GRAD.

Definition at line 505 of file defines.h.

             {
    AF_DIFFUSION_GRAD = 1,      
    AF_DIFFUSION_MCDE = 2,      
    AF_DIFFUSION_DEFAULT = 0    
} af_diffusion_eq;

af_dtype

enum af_dtype

Enumerator
f32	32-bit floating point values
c32	32-bit complex floating point values
f64	64-bit floating point values
c64	64-bit complex floating point values
b8	8-bit boolean values
s32	32-bit signed integral values
u32	32-bit unsigned integral values
u8	8-bit unsigned integral values
s64	64-bit signed integral values
u64	64-bit unsigned integral values
s16	16-bit signed integral values
u16	16-bit unsigned integral values
f16	16-bit floating point value

Definition at line 210 of file defines.h.

             {
    f32,    
    c32,    
    f64,    
    c64,    
    b8 ,    
    s32,    
    u32,    
    u8 ,    
    s64,    
    u64    
#if AF_API_VERSION >= 32
    , s16    
#endif
#if AF_API_VERSION >= 32
    , u16    
#endif
#if AF_API_VERSION >= 37
    , f16    
#endif
} af_dtype;

af_err

enum af_err

Enumerator
AF_SUCCESS	The function returned successfully.
AF_ERR_NO_MEM
AF_ERR_DRIVER
AF_ERR_RUNTIME
AF_ERR_INVALID_ARRAY
AF_ERR_ARG
AF_ERR_SIZE
AF_ERR_TYPE
AF_ERR_DIFF_TYPE
AF_ERR_BATCH
AF_ERR_DEVICE
AF_ERR_NOT_SUPPORTED
AF_ERR_NOT_CONFIGURED
AF_ERR_NONFREE
AF_ERR_NO_DBL
AF_ERR_NO_GFX
AF_ERR_NO_HALF
AF_ERR_LOAD_LIB
AF_ERR_LOAD_SYM
AF_ERR_ARR_BKND_MISMATCH
AF_ERR_INTERNAL
AF_ERR_UNKNOWN

Definition at line 71 of file defines.h.

             {
    AF_SUCCESS            =   0
 
    // 100-199 Errors in environment
 
    , AF_ERR_NO_MEM         = 101
 
    , AF_ERR_DRIVER         = 102
 
    , AF_ERR_RUNTIME        = 103
 
    // 200-299 Errors in input parameters
 
    , AF_ERR_INVALID_ARRAY  = 201
 
    , AF_ERR_ARG            = 202
 
    , AF_ERR_SIZE           = 203
 
    , AF_ERR_TYPE           = 204
 
    , AF_ERR_DIFF_TYPE      = 205
 
    , AF_ERR_BATCH          = 207
 
 
#if AF_API_VERSION >= 33
    , AF_ERR_DEVICE         = 208
#endif
 
    // 300-399 Errors for missing software features
 
    , AF_ERR_NOT_SUPPORTED  = 301
 
    , AF_ERR_NOT_CONFIGURED = 302
 
#if AF_API_VERSION >= 32
    , AF_ERR_NONFREE        = 303
#endif
 
    // 400-499 Errors for missing hardware features
 
    , AF_ERR_NO_DBL         = 401
 
    , AF_ERR_NO_GFX         = 402
 
#if AF_API_VERSION >= 37
    , AF_ERR_NO_HALF        = 403
#endif
 
    // 500-599 Errors specific to heterogenous API
 
#if AF_API_VERSION >= 32
    , AF_ERR_LOAD_LIB       = 501
#endif
 
#if AF_API_VERSION >= 32
    , AF_ERR_LOAD_SYM       = 502
#endif
 
#if AF_API_VERSION >= 32
    , AF_ERR_ARR_BKND_MISMATCH    = 503
#endif
 
    // 900-999 Errors from upstream libraries and runtimes
 
    , AF_ERR_INTERNAL       = 998
 
    , AF_ERR_UNKNOWN        = 999
} af_err;

af_flux_function

enum af_flux_function

Enumerator
AF_FLUX_QUADRATIC	Quadratic flux function.
AF_FLUX_EXPONENTIAL	Exponential flux function.
AF_FLUX_DEFAULT	Default flux function is exponential.

Definition at line 499 of file defines.h.

             {
    AF_FLUX_QUADRATIC   = 1,    
    AF_FLUX_EXPONENTIAL = 2,    
    AF_FLUX_DEFAULT     = 0     
} af_flux_function;

af_homography_type

enum af_homography_type

Enumerator
AF_HOMOGRAPHY_RANSAC	Computes homography using RANSAC.
AF_HOMOGRAPHY_LMEDS	Computes homography using Least Median of Squares.

Definition at line 405 of file defines.h.

             {
    AF_HOMOGRAPHY_RANSAC = 0,   
    AF_HOMOGRAPHY_LMEDS  = 1    
} af_homography_type;

af_image_format

enum af_image_format

Enumerator
AF_FIF_BMP	FreeImage Enum for Bitmap File.
AF_FIF_ICO	FreeImage Enum for Windows Icon File.
AF_FIF_JPEG	FreeImage Enum for JPEG File.
AF_FIF_JNG	FreeImage Enum for JPEG Network Graphics File.
AF_FIF_PNG	FreeImage Enum for Portable Network Graphics File.
AF_FIF_PPM	FreeImage Enum for Portable Pixelmap (ASCII) File.
AF_FIF_PPMRAW	FreeImage Enum for Portable Pixelmap (Binary) File.
AF_FIF_TIFF	FreeImage Enum for Tagged Image File Format File.
AF_FIF_PSD	FreeImage Enum for Adobe Photoshop File.
AF_FIF_HDR	FreeImage Enum for High Dynamic Range File.
AF_FIF_EXR	FreeImage Enum for ILM OpenEXR File.
AF_FIF_JP2	FreeImage Enum for JPEG-2000 File.
AF_FIF_RAW	FreeImage Enum for RAW Camera Image File.

Definition at line 377 of file defines.h.

             {
    AF_FIF_BMP          = 0,    
    AF_FIF_ICO          = 1,    
    AF_FIF_JPEG         = 2,    
    AF_FIF_JNG          = 3,    
    AF_FIF_PNG          = 13,   
    AF_FIF_PPM          = 14,   
    AF_FIF_PPMRAW       = 15,   
    AF_FIF_TIFF         = 18,   
    AF_FIF_PSD          = 20,   
    AF_FIF_HDR          = 26,   
    AF_FIF_EXR          = 29,   
    AF_FIF_JP2          = 31,   
    AF_FIF_RAW          = 34    
} af_image_format;

af_interp_type

enum af_interp_type

Enumerator
AF_INTERP_NEAREST	Nearest Interpolation.
AF_INTERP_LINEAR	Linear Interpolation.
AF_INTERP_BILINEAR	Bilinear Interpolation.
AF_INTERP_CUBIC	Cubic Interpolation.
AF_INTERP_LOWER	Floor Indexed.
AF_INTERP_LINEAR_COSINE	Linear Interpolation with cosine smoothing.
AF_INTERP_BILINEAR_COSINE	Bilinear Interpolation with cosine smoothing.
AF_INTERP_BICUBIC	Bicubic Interpolation.
AF_INTERP_CUBIC_SPLINE	Cubic Interpolation with Catmull-Rom splines.
AF_INTERP_BICUBIC_SPLINE	Bicubic Interpolation with Catmull-Rom splines.

Definition at line 242 of file defines.h.

             {
    AF_INTERP_NEAREST,         
    AF_INTERP_LINEAR,          
    AF_INTERP_BILINEAR,        
    AF_INTERP_CUBIC,           
    AF_INTERP_LOWER           
#if AF_API_VERSION >= 34
    , AF_INTERP_LINEAR_COSINE   
#endif
#if AF_API_VERSION >= 34
    , AF_INTERP_BILINEAR_COSINE 
#endif
#if AF_API_VERSION >= 34
    , AF_INTERP_BICUBIC         
#endif
#if AF_API_VERSION >= 34
    , AF_INTERP_CUBIC_SPLINE    
#endif
#if AF_API_VERSION >= 34
    , AF_INTERP_BICUBIC_SPLINE  
#endif
 
} af_interp_type;

af_inverse_deconv_algo

enum af_inverse_deconv_algo

Enumerator
AF_INVERSE_DECONV_TIKHONOV	Tikhonov Inverse deconvolution.
AF_INVERSE_DECONV_DEFAULT	Default is Tikhonov deconvolution.

Definition at line 534 of file defines.h.

             {
    AF_INVERSE_DECONV_TIKHONOV       = 1,        
    AF_INVERSE_DECONV_DEFAULT        = 0         
} af_inverse_deconv_algo;

af_iterative_deconv_algo

enum af_iterative_deconv_algo

Enumerator
AF_ITERATIVE_DECONV_LANDWEBER	Landweber Deconvolution.
AF_ITERATIVE_DECONV_RICHARDSONLUCY	Richardson-Lucy Deconvolution.
AF_ITERATIVE_DECONV_DEFAULT	Default is Landweber deconvolution.

Definition at line 528 of file defines.h.

             {
    AF_ITERATIVE_DECONV_LANDWEBER       = 1,        
    AF_ITERATIVE_DECONV_RICHARDSONLUCY  = 2,        
    AF_ITERATIVE_DECONV_DEFAULT         = 0         
} af_iterative_deconv_algo;

af_marker_type

enum af_marker_type

Enumerator
AF_MARKER_NONE
AF_MARKER_POINT
AF_MARKER_CIRCLE
AF_MARKER_SQUARE
AF_MARKER_TRIANGLE
AF_MARKER_CROSS
AF_MARKER_PLUS
AF_MARKER_STAR

Definition at line 469 of file defines.h.

             {
    AF_MARKER_NONE         = 0,
    AF_MARKER_POINT        = 1,
    AF_MARKER_CIRCLE       = 2,
    AF_MARKER_SQUARE       = 3,
    AF_MARKER_TRIANGLE     = 4,
    AF_MARKER_CROSS        = 5,
    AF_MARKER_PLUS         = 6,
    AF_MARKER_STAR         = 7
} af_marker_type;

af_mat_prop

enum af_mat_prop

Enumerator
AF_MAT_NONE	Default.
AF_MAT_TRANS	Data needs to be transposed.
AF_MAT_CTRANS	Data needs to be conjugate tansposed.
AF_MAT_CONJ	Data needs to be conjugate.
AF_MAT_UPPER	Matrix is upper triangular.
AF_MAT_LOWER	Matrix is lower triangular.
AF_MAT_DIAG_UNIT	Matrix diagonal contains unitary values.
AF_MAT_SYM	Matrix is symmetric.
AF_MAT_POSDEF	Matrix is positive definite.
AF_MAT_ORTHOG	Matrix is orthogonal.
AF_MAT_TRI_DIAG	Matrix is tri diagonal.
AF_MAT_BLOCK_DIAG	Matrix is block diagonal.

Definition at line 348 of file defines.h.

             {
    AF_MAT_NONE       = 0,    
    AF_MAT_TRANS      = 1,    
    AF_MAT_CTRANS     = 2,    
    AF_MAT_CONJ       = 4,    
    AF_MAT_UPPER      = 32,   
    AF_MAT_LOWER      = 64,   
    AF_MAT_DIAG_UNIT  = 128,  
    AF_MAT_SYM        = 512,  
    AF_MAT_POSDEF     = 1024, 
    AF_MAT_ORTHOG     = 2048, 
    AF_MAT_TRI_DIAG   = 4096, 
    AF_MAT_BLOCK_DIAG = 8192  
} af_mat_prop;

af_match_type

enum af_match_type

Enumerator
AF_SAD	Match based on Sum of Absolute Differences (SAD)
AF_ZSAD	Match based on Zero mean SAD.
AF_LSAD	Match based on Locally scaled SAD.
AF_SSD	Match based on Sum of Squared Differences (SSD)
AF_ZSSD	Match based on Zero mean SSD.
AF_LSSD	Match based on Locally scaled SSD.
AF_NCC	Match based on Normalized Cross Correlation (NCC)
AF_ZNCC	Match based on Zero mean NCC.
AF_SHD	Match based on Sum of Hamming Distances (SHD)

Definition at line 319 of file defines.h.

             {
    AF_SAD = 0,   
    AF_ZSAD,      
    AF_LSAD,      
    AF_SSD,       
    AF_ZSSD,      
    AF_LSSD,      
    AF_NCC,       
    AF_ZNCC,      
    AF_SHD        
} af_match_type;

af_moment_type

enum af_moment_type

Enumerator
AF_MOMENT_M00
AF_MOMENT_M01
AF_MOMENT_M10
AF_MOMENT_M11
AF_MOMENT_FIRST_ORDER

Definition at line 395 of file defines.h.

             {
    AF_MOMENT_M00 = 1,
    AF_MOMENT_M01 = 2,
    AF_MOMENT_M10 = 4,
    AF_MOMENT_M11 = 8,
    AF_MOMENT_FIRST_ORDER = AF_MOMENT_M00 | AF_MOMENT_M01 | AF_MOMENT_M10 | AF_MOMENT_M11
} af_moment_type;

af_norm_type

enum af_norm_type

Enumerator
AF_NORM_VECTOR_1	treats the input as a vector and returns the sum of absolute values
AF_NORM_VECTOR_INF	treats the input as a vector and returns the max of absolute values
AF_NORM_VECTOR_2	treats the input as a vector and returns euclidean norm
AF_NORM_VECTOR_P	treats the input as a vector and returns the p-norm
AF_NORM_MATRIX_1	return the max of column sums
AF_NORM_MATRIX_INF	return the max of row sums
AF_NORM_MATRIX_2	returns the max singular value). Currently NOT SUPPORTED
AF_NORM_MATRIX_L_PQ	returns Lpq-norm
AF_NORM_EUCLID	The default. Same as AF_NORM_VECTOR_2.

Definition at line 363 of file defines.h.

             {
    AF_NORM_VECTOR_1,      
    AF_NORM_VECTOR_INF,    
    AF_NORM_VECTOR_2,      
    AF_NORM_VECTOR_P,      
    AF_NORM_MATRIX_1,      
    AF_NORM_MATRIX_INF,    
    AF_NORM_MATRIX_2,      
    AF_NORM_MATRIX_L_PQ,   
 
    AF_NORM_EUCLID = AF_NORM_VECTOR_2 
} af_norm_type;

af_random_engine_type

enum af_random_engine_type

Enumerator
AF_RANDOM_ENGINE_PHILOX_4X32_10
AF_RANDOM_ENGINE_THREEFRY_2X32_16
AF_RANDOM_ENGINE_MERSENNE_GP11213
AF_RANDOM_ENGINE_PHILOX
AF_RANDOM_ENGINE_THREEFRY
AF_RANDOM_ENGINE_MERSENNE
AF_RANDOM_ENGINE_DEFAULT

Definition at line 439 of file defines.h.

             {
    AF_RANDOM_ENGINE_PHILOX_4X32_10     = 100,                                  //Philox variant with N = 4, W = 32 and Rounds = 10
    AF_RANDOM_ENGINE_THREEFRY_2X32_16   = 200,                                  //Threefry variant with N = 2, W = 32 and Rounds = 16
    AF_RANDOM_ENGINE_MERSENNE_GP11213   = 300,                                  //Mersenne variant with MEXP = 11213
    AF_RANDOM_ENGINE_PHILOX             = AF_RANDOM_ENGINE_PHILOX_4X32_10,      //Resolves to Philox 4x32_10
    AF_RANDOM_ENGINE_THREEFRY           = AF_RANDOM_ENGINE_THREEFRY_2X32_16,    //Resolves to Threefry 2X32_16
    AF_RANDOM_ENGINE_MERSENNE           = AF_RANDOM_ENGINE_MERSENNE_GP11213,    //Resolves to Mersenne GP 11213
    AF_RANDOM_ENGINE_DEFAULT            = AF_RANDOM_ENGINE_PHILOX               //Resolves to Philox
} af_random_engine_type;

af_someenum_t

enum af_someenum_t

Enumerator
AF_ID

Definition at line 425 of file defines.h.

             {
    AF_ID = 0
} af_someenum_t;

af_source

enum af_source

Enumerator
afDevice	Device pointer.
afHost	Host pointer.

Definition at line 232 of file defines.h.

             {
    afDevice,   
    afHost     
} af_source;

af_storage

enum af_storage

Enumerator
AF_STORAGE_DENSE	Storage type is dense.
AF_STORAGE_CSR	Storage type is CSR.
AF_STORAGE_CSC	Storage type is CSC.
AF_STORAGE_COO	Storage type is COO.

Definition at line 490 of file defines.h.

             {
    AF_STORAGE_DENSE     = 0,   
    AF_STORAGE_CSR       = 1,   
    AF_STORAGE_CSC       = 2,   
    AF_STORAGE_COO       = 3    
} af_storage;

af_topk_function

enum af_topk_function

Enumerator
AF_TOPK_MIN	Top k min values.
AF_TOPK_MAX	Top k max values.
AF_TOPK_STABLE	Preserve order of indices for equal values.
AF_TOPK_STABLE_MIN	Top k min with stable indices.
AF_TOPK_STABLE_MAX	Top k max with stable indices.
AF_TOPK_DEFAULT	Default option (max)

Definition at line 511 of file defines.h.

             {
    AF_TOPK_MIN         = 1,  
    AF_TOPK_MAX         = 2,  
    AF_TOPK_STABLE      = 4,  
    AF_TOPK_STABLE_MIN  = AF_TOPK_STABLE | AF_TOPK_MIN, 
    AF_TOPK_STABLE_MAX  = AF_TOPK_STABLE | AF_TOPK_MAX, 
    AF_TOPK_DEFAULT = 0   
} af_topk_function;

af_var_bias

enum af_var_bias

Enumerator
AF_VARIANCE_DEFAULT	Default (Population) variance.
AF_VARIANCE_SAMPLE	Sample variance.
AF_VARIANCE_POPULATION	Population variance.

Definition at line 522 of file defines.h.

             {
    AF_VARIANCE_DEFAULT    = 0, 
    AF_VARIANCE_SAMPLE     = 1, 
    AF_VARIANCE_POPULATION = 2  
} af_var_bias;

af_ycc_std

enum af_ycc_std

Enumerator
AF_YCC_601	ITU-R BT.601 (formerly CCIR 601) standard.
AF_YCC_709	ITU-R BT.709 standard.
AF_YCC_2020	ITU-R BT.2020 standard.

Definition at line 332 of file defines.h.

             {
    AF_YCC_601 = 601,  
    AF_YCC_709 = 709,  
    AF_YCC_2020 = 2020 
} af_ycc_std;