A high-performance general-purpose compute library

- Main Page
- Tutorials
- Release Notes
- Examples

Namespaces | Macros | Typedefs | Enumerations
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.

413 {
414 AF_BACKEND_DEFAULT = 0,
415 AF_BACKEND_CPU = 1,
416 AF_BACKEND_CUDA = 2,
417 AF_BACKEND_OPENCL = 4,
418 AF_BACKEND_ONEAPI = 8
419} af_backend;
af_backend
af_backend
Definition defines.h:413
AF_BACKEND_ONEAPI
@ AF_BACKEND_ONEAPI
OneAPI Compute Backend.
Definition defines.h:418
AF_BACKEND_CUDA
@ AF_BACKEND_CUDA
CUDA Compute Backend.
Definition defines.h:416
AF_BACKEND_OPENCL
@ AF_BACKEND_OPENCL
OpenCL Compute Backend.
Definition defines.h:417
AF_BACKEND_CPU
@ AF_BACKEND_CPU
CPU a.k.a sequential algorithms.
Definition defines.h:415
AF_BACKEND_DEFAULT
@ AF_BACKEND_DEFAULT
Default backend order: OpenCL -> CUDA -> CPU.
Definition defines.h:414

## ◆ 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.

430 {
431 AF_BINARY_ADD = 0,
432 AF_BINARY_MUL = 1,
433 AF_BINARY_MIN = 2,
434 AF_BINARY_MAX = 3
435} af_binary_op;
af_binary_op
af_binary_op
Definition defines.h:430
AF_BINARY_MAX
@ AF_BINARY_MAX
Definition defines.h:434
AF_BINARY_ADD
@ AF_BINARY_ADD
Definition defines.h:431
AF_BINARY_MUL
@ AF_BINARY_MUL
Definition defines.h:432
AF_BINARY_MIN
@ AF_BINARY_MIN
Definition defines.h:433

## ◆ 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.

266 {
270 AF_PAD_ZERO = 0,
271
275 AF_PAD_SYM,
276
280 AF_PAD_CLAMP_TO_EDGE,
281
285 AF_PAD_PERIODIC
286} af_border_type;
af_border_type
af_border_type
Definition defines.h:266
AF_PAD_SYM
@ AF_PAD_SYM
Out of bound values are symmetric over the edge.
Definition defines.h:275
AF_PAD_PERIODIC
@ AF_PAD_PERIODIC
Out of bound values are mapped to range of the dimension in cyclic fashion.
Definition defines.h:285
AF_PAD_CLAMP_TO_EDGE
@ AF_PAD_CLAMP_TO_EDGE
Out of bound values are clamped to the edge.
Definition defines.h:280
AF_PAD_ZERO
@ AF_PAD_ZERO
Out of bound values are 0.
Definition defines.h:270

## ◆ 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.

483 {
484 AF_CANNY_THRESHOLD_MANUAL = 0,
485 AF_CANNY_THRESHOLD_AUTO_OTSU = 1
486} af_canny_threshold;
af_canny_threshold
af_canny_threshold
Definition defines.h:483
AF_CANNY_THRESHOLD_AUTO_OTSU
@ AF_CANNY_THRESHOLD_AUTO_OTSU
Determine canny algorithm thresholds using Otsu algorithm.
Definition defines.h:485
AF_CANNY_THRESHOLD_MANUAL
@ AF_CANNY_THRESHOLD_MANUAL
User has to define canny thresholds manually.
Definition defines.h:484

## ◆ 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.

454 {
455 AF_COLORMAP_DEFAULT = 0,
456 AF_COLORMAP_SPECTRUM= 1,
457 AF_COLORMAP_COLORS = 2,
458 AF_COLORMAP_RED = 3,
459 AF_COLORMAP_MOOD = 4,
460 AF_COLORMAP_HEAT = 5,
461 AF_COLORMAP_BLUE = 6,
462 AF_COLORMAP_INFERNO = 7,
463 AF_COLORMAP_MAGMA = 8,
464 AF_COLORMAP_PLASMA = 9,
465 AF_COLORMAP_VIRIDIS = 10
466} af_colormap;
af_colormap
af_colormap
Definition defines.h:454
AF_COLORMAP_COLORS
@ AF_COLORMAP_COLORS
Colors, aka. Rainbow.
Definition defines.h:457
AF_COLORMAP_SPECTRUM
@ AF_COLORMAP_SPECTRUM
Spectrum map (390nm-830nm, in sRGB colorspace)
Definition defines.h:456
AF_COLORMAP_DEFAULT
@ AF_COLORMAP_DEFAULT
Default grayscale map.
Definition defines.h:455
AF_COLORMAP_VIRIDIS
@ AF_COLORMAP_VIRIDIS
Perceptually uniform shades of blue-green-yellow.
Definition defines.h:465
AF_COLORMAP_BLUE
@ AF_COLORMAP_BLUE
Blue hue map.
Definition defines.h:461
AF_COLORMAP_HEAT
@ AF_COLORMAP_HEAT
Heat map.
Definition defines.h:460
AF_COLORMAP_RED
@ AF_COLORMAP_RED
Red hue map.
Definition defines.h:458
AF_COLORMAP_PLASMA
@ AF_COLORMAP_PLASMA
Perceptually uniform shades of blue-red-yellow.
Definition defines.h:464
AF_COLORMAP_MAGMA
@ AF_COLORMAP_MAGMA
Perceptually uniform shades of black-red-white.
Definition defines.h:463
AF_COLORMAP_MOOD
@ AF_COLORMAP_MOOD
Mood map.
Definition defines.h:459
AF_COLORMAP_INFERNO
@ AF_COLORMAP_INFERNO
Perceptually uniform shades of black-red-yellow.
Definition defines.h:462

## ◆ 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.

288 {
292 AF_CONNECTIVITY_4 = 4,
293
297 AF_CONNECTIVITY_8 = 8
298} af_connectivity;
af_connectivity
af_connectivity
Definition defines.h:288
AF_CONNECTIVITY_4
@ AF_CONNECTIVITY_4
Connectivity includes neighbors, North, East, South and West of current pixel.
Definition defines.h:292
AF_CONNECTIVITY_8
@ AF_CONNECTIVITY_8
Connectivity includes 4-connectivity neigbors and also those on Northeast, Northwest,...
Definition defines.h:297

## ◆ 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.

313 {
314 AF_CONV_AUTO,
315 AF_CONV_SPATIAL,
316 AF_CONV_FREQ
317} af_conv_domain;
af_conv_domain
af_conv_domain
Definition defines.h:313
AF_CONV_FREQ
@ AF_CONV_FREQ
Perform convolution in frequency domain.
Definition defines.h:316
AF_CONV_SPATIAL
@ AF_CONV_SPATIAL
Perform convolution in spatial domain.
Definition defines.h:315
AF_CONV_AUTO
@ AF_CONV_AUTO
ArrayFire automatically picks the right convolution algorithm.
Definition defines.h:314

## ◆ 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.

542 {
543 AF_CONV_GRADIENT_DEFAULT = 0,
544 AF_CONV_GRADIENT_FILTER = 1,
545 AF_CONV_GRADIENT_DATA = 2,
546 AF_CONV_GRADIENT_BIAS = 3
547} af_conv_gradient_type;
af_conv_gradient_type
af_conv_gradient_type
Definition defines.h:542
AF_CONV_GRADIENT_DATA
@ AF_CONV_GRADIENT_DATA
Definition defines.h:545
AF_CONV_GRADIENT_BIAS
@ AF_CONV_GRADIENT_BIAS
Definition defines.h:546
AF_CONV_GRADIENT_FILTER
@ AF_CONV_GRADIENT_FILTER
Definition defines.h:544
AF_CONV_GRADIENT_DEFAULT
@ AF_CONV_GRADIENT_DEFAULT
Definition defines.h:543

## ◆ 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.

300 {
301
305 AF_CONV_DEFAULT,
306
310 AF_CONV_EXPAND
311} af_conv_mode;
af_conv_mode
af_conv_mode
Definition defines.h:300
AF_CONV_DEFAULT
@ AF_CONV_DEFAULT
Output of the convolution is the same size as input.
Definition defines.h:305
AF_CONV_EXPAND
@ AF_CONV_EXPAND
Output of the convolution is signal_len + filter_len - 1.
Definition defines.h:310

## ◆ 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.

339 {
340 AF_GRAY = 0,
341 AF_RGB,
342 AF_HSV
343#if AF_API_VERSION >= 31
344 , AF_YCbCr
345#endif
346} af_cspace_t;
af_cspace_t
af_cspace_t
Definition defines.h:339
AF_GRAY
@ AF_GRAY
Grayscale.
Definition defines.h:340
AF_HSV
@ AF_HSV
3-channel HSV
Definition defines.h:342
AF_YCbCr
@ AF_YCbCr
3-channel YCbCr
Definition defines.h:344
AF_RGB
@ AF_RGB
3-channel RGB
Definition defines.h:341

## ◆ 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.

505 {
506 AF_DIFFUSION_GRAD = 1,
507 AF_DIFFUSION_MCDE = 2,
508 AF_DIFFUSION_DEFAULT = 0
509} af_diffusion_eq;
af_diffusion_eq
af_diffusion_eq
Definition defines.h:505
AF_DIFFUSION_MCDE
@ AF_DIFFUSION_MCDE
Modified curvature diffusion equation.
Definition defines.h:507
AF_DIFFUSION_GRAD
@ AF_DIFFUSION_GRAD
Gradient diffusion equation.
Definition defines.h:506
AF_DIFFUSION_DEFAULT
@ AF_DIFFUSION_DEFAULT
Default option is same as AF_DIFFUSION_GRAD.
Definition defines.h:508

## ◆ 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.

210 {
211 f32,
212 c32,
213 f64,
214 c64,
215 b8 ,
216 s32,
217 u32,
218 u8 ,
219 s64,
220 u64
221#if AF_API_VERSION >= 32
222 , s16
223#endif
224#if AF_API_VERSION >= 32
225 , u16
226#endif
227#if AF_API_VERSION >= 37
228 , f16
229#endif
230} af_dtype;
af_dtype
af_dtype
Definition defines.h:210
u32
@ u32
32-bit unsigned integral values
Definition defines.h:217
u64
@ u64
64-bit unsigned integral values
Definition defines.h:220
s32
@ s32
32-bit signed integral values
Definition defines.h:216
s64
@ s64
64-bit signed integral values
Definition defines.h:219
b8
@ b8
8-bit boolean values
Definition defines.h:215
c64
@ c64
64-bit complex floating point values
Definition defines.h:214
f32
@ f32
32-bit floating point values
Definition defines.h:211
s16
@ s16
16-bit signed integral values
Definition defines.h:222
c32
@ c32
32-bit complex floating point values
Definition defines.h:212
f64
@ f64
64-bit floating point values
Definition defines.h:213
u16
@ u16
16-bit unsigned integral values
Definition defines.h:225
f16
@ f16
16-bit floating point value
Definition defines.h:228
u8
@ u8
8-bit unsigned integral values
Definition defines.h:218

## ◆ 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.

71 {
75 AF_SUCCESS = 0
76
77 // 100-199 Errors in environment
78
82 , AF_ERR_NO_MEM = 101
83
87 , AF_ERR_DRIVER = 102
88
92 , AF_ERR_RUNTIME = 103
93
94 // 200-299 Errors in input parameters
95
99 , AF_ERR_INVALID_ARRAY = 201
100
104 , AF_ERR_ARG = 202
105
109 , AF_ERR_SIZE = 203
110
114 , AF_ERR_TYPE = 204
115
119 , AF_ERR_DIFF_TYPE = 205
120
124 , AF_ERR_BATCH = 207
125
126
127#if AF_API_VERSION >= 33
131 , AF_ERR_DEVICE = 208
132#endif
133
134 // 300-399 Errors for missing software features
135
139 , AF_ERR_NOT_SUPPORTED = 301
140
144 , AF_ERR_NOT_CONFIGURED = 302
145
146#if AF_API_VERSION >= 32
150 , AF_ERR_NONFREE = 303
151#endif
152
153 // 400-499 Errors for missing hardware features
154
158 , AF_ERR_NO_DBL = 401
159
164 , AF_ERR_NO_GFX = 402
165
166#if AF_API_VERSION >= 37
170 , AF_ERR_NO_HALF = 403
171#endif
172
173 // 500-599 Errors specific to heterogenous API
174
175#if AF_API_VERSION >= 32
179 , AF_ERR_LOAD_LIB = 501
180#endif
181
182#if AF_API_VERSION >= 32
186 , AF_ERR_LOAD_SYM = 502
187#endif
188
189#if AF_API_VERSION >= 32
193 , AF_ERR_ARR_BKND_MISMATCH = 503
194#endif
195
196 // 900-999 Errors from upstream libraries and runtimes
197
202 , AF_ERR_INTERNAL = 998
203
207 , AF_ERR_UNKNOWN = 999
208} af_err;
af_err
af_err
Definition defines.h:71
AF_ERR_NOT_CONFIGURED
@ AF_ERR_NOT_CONFIGURED
Definition defines.h:144
AF_ERR_ARR_BKND_MISMATCH
@ AF_ERR_ARR_BKND_MISMATCH
Definition defines.h:193
AF_ERR_NONFREE
@ AF_ERR_NONFREE
Definition defines.h:150
AF_ERR_RUNTIME
@ AF_ERR_RUNTIME
Definition defines.h:92
AF_SUCCESS
@ AF_SUCCESS
The function returned successfully.
Definition defines.h:75
AF_ERR_DIFF_TYPE
@ AF_ERR_DIFF_TYPE
Definition defines.h:119
AF_ERR_NO_DBL
@ AF_ERR_NO_DBL
Definition defines.h:158
AF_ERR_LOAD_LIB
@ AF_ERR_LOAD_LIB
Definition defines.h:179
AF_ERR_LOAD_SYM
@ AF_ERR_LOAD_SYM
Definition defines.h:186
AF_ERR_NO_HALF
@ AF_ERR_NO_HALF
Definition defines.h:170
AF_ERR_BATCH
@ AF_ERR_BATCH
Definition defines.h:124
AF_ERR_DRIVER
@ AF_ERR_DRIVER
Definition defines.h:87
AF_ERR_NOT_SUPPORTED
@ AF_ERR_NOT_SUPPORTED
Definition defines.h:139
AF_ERR_NO_GFX
@ AF_ERR_NO_GFX
Definition defines.h:164
AF_ERR_INVALID_ARRAY
@ AF_ERR_INVALID_ARRAY
Definition defines.h:99
AF_ERR_TYPE
@ AF_ERR_TYPE
Definition defines.h:114
AF_ERR_NO_MEM
@ AF_ERR_NO_MEM
Definition defines.h:82
AF_ERR_DEVICE
@ AF_ERR_DEVICE
Definition defines.h:131
AF_ERR_UNKNOWN
@ AF_ERR_UNKNOWN
Definition defines.h:207
AF_ERR_ARG
@ AF_ERR_ARG
Definition defines.h:104
AF_ERR_INTERNAL
@ AF_ERR_INTERNAL
Definition defines.h:202
AF_ERR_SIZE
@ AF_ERR_SIZE
Definition defines.h:109

## ◆ 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.

499 {
500 AF_FLUX_QUADRATIC = 1,
501 AF_FLUX_EXPONENTIAL = 2,
502 AF_FLUX_DEFAULT = 0
503} af_flux_function;
af_flux_function
af_flux_function
Definition defines.h:499
AF_FLUX_EXPONENTIAL
@ AF_FLUX_EXPONENTIAL
Exponential flux function.
Definition defines.h:501
AF_FLUX_QUADRATIC
@ AF_FLUX_QUADRATIC
Quadratic flux function.
Definition defines.h:500
AF_FLUX_DEFAULT
@ AF_FLUX_DEFAULT
Default flux function is exponential.
Definition defines.h:502

## ◆ 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.

405 {
406 AF_HOMOGRAPHY_RANSAC = 0,
407 AF_HOMOGRAPHY_LMEDS = 1
408} af_homography_type;
af_homography_type
af_homography_type
Definition defines.h:405
AF_HOMOGRAPHY_RANSAC
@ AF_HOMOGRAPHY_RANSAC
Computes homography using RANSAC.
Definition defines.h:406
AF_HOMOGRAPHY_LMEDS
@ AF_HOMOGRAPHY_LMEDS
Computes homography using Least Median of Squares.
Definition defines.h:407

## ◆ 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.

377 {
378 AF_FIF_BMP = 0,
379 AF_FIF_ICO = 1,
380 AF_FIF_JPEG = 2,
381 AF_FIF_JNG = 3,
382 AF_FIF_PNG = 13,
383 AF_FIF_PPM = 14,
384 AF_FIF_PPMRAW = 15,
385 AF_FIF_TIFF = 18,
386 AF_FIF_PSD = 20,
387 AF_FIF_HDR = 26,
388 AF_FIF_EXR = 29,
389 AF_FIF_JP2 = 31,
390 AF_FIF_RAW = 34
391} af_image_format;
af_image_format
af_image_format
Definition defines.h:377
AF_FIF_PNG
@ AF_FIF_PNG
FreeImage Enum for Portable Network Graphics File.
Definition defines.h:382
AF_FIF_PSD
@ AF_FIF_PSD
FreeImage Enum for Adobe Photoshop File.
Definition defines.h:386
AF_FIF_PPMRAW
@ AF_FIF_PPMRAW
FreeImage Enum for Portable Pixelmap (Binary) File.
Definition defines.h:384
AF_FIF_JPEG
@ AF_FIF_JPEG
FreeImage Enum for JPEG File.
Definition defines.h:380
AF_FIF_JP2
@ AF_FIF_JP2
FreeImage Enum for JPEG-2000 File.
Definition defines.h:389
AF_FIF_PPM
@ AF_FIF_PPM
FreeImage Enum for Portable Pixelmap (ASCII) File.
Definition defines.h:383
AF_FIF_BMP
@ AF_FIF_BMP
FreeImage Enum for Bitmap File.
Definition defines.h:378
AF_FIF_ICO
@ AF_FIF_ICO
FreeImage Enum for Windows Icon File.
Definition defines.h:379
AF_FIF_RAW
@ AF_FIF_RAW
FreeImage Enum for RAW Camera Image File.
Definition defines.h:390
AF_FIF_EXR
@ AF_FIF_EXR
FreeImage Enum for ILM OpenEXR File.
Definition defines.h:388
AF_FIF_TIFF
@ AF_FIF_TIFF
FreeImage Enum for Tagged Image File Format File.
Definition defines.h:385
AF_FIF_HDR
@ AF_FIF_HDR
FreeImage Enum for High Dynamic Range File.
Definition defines.h:387
AF_FIF_JNG
@ AF_FIF_JNG
FreeImage Enum for JPEG Network Graphics File.
Definition defines.h:381

## ◆ 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.

242 {
243 AF_INTERP_NEAREST,
244 AF_INTERP_LINEAR,
245 AF_INTERP_BILINEAR,
246 AF_INTERP_CUBIC,
247 AF_INTERP_LOWER
248#if AF_API_VERSION >= 34
249 , AF_INTERP_LINEAR_COSINE
250#endif
251#if AF_API_VERSION >= 34
252 , AF_INTERP_BILINEAR_COSINE
253#endif
254#if AF_API_VERSION >= 34
255 , AF_INTERP_BICUBIC
256#endif
257#if AF_API_VERSION >= 34
258 , AF_INTERP_CUBIC_SPLINE
259#endif
260#if AF_API_VERSION >= 34
261 , AF_INTERP_BICUBIC_SPLINE
262#endif
263
264} af_interp_type;
af_interp_type
af_interp_type
Definition defines.h:242
AF_INTERP_CUBIC
@ AF_INTERP_CUBIC
Cubic Interpolation.
Definition defines.h:246
AF_INTERP_LOWER
@ AF_INTERP_LOWER
Floor Indexed.
Definition defines.h:247
AF_INTERP_LINEAR_COSINE
@ AF_INTERP_LINEAR_COSINE
Linear Interpolation with cosine smoothing.
Definition defines.h:249
AF_INTERP_LINEAR
@ AF_INTERP_LINEAR
Linear Interpolation.
Definition defines.h:244
AF_INTERP_NEAREST
@ AF_INTERP_NEAREST
Nearest Interpolation.
Definition defines.h:243
AF_INTERP_BILINEAR_COSINE
@ AF_INTERP_BILINEAR_COSINE
Bilinear Interpolation with cosine smoothing.
Definition defines.h:252
AF_INTERP_CUBIC_SPLINE
@ AF_INTERP_CUBIC_SPLINE
Cubic Interpolation with Catmull-Rom splines.
Definition defines.h:258
AF_INTERP_BICUBIC
@ AF_INTERP_BICUBIC
Bicubic Interpolation.
Definition defines.h:255
AF_INTERP_BICUBIC_SPLINE
@ AF_INTERP_BICUBIC_SPLINE
Bicubic Interpolation with Catmull-Rom splines.
Definition defines.h:261
AF_INTERP_BILINEAR
@ AF_INTERP_BILINEAR
Bilinear Interpolation.
Definition defines.h:245

## ◆ 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.

534 {
535 AF_INVERSE_DECONV_TIKHONOV = 1,
536 AF_INVERSE_DECONV_DEFAULT = 0
537} af_inverse_deconv_algo;
af_inverse_deconv_algo
af_inverse_deconv_algo
Definition defines.h:534
AF_INVERSE_DECONV_DEFAULT
@ AF_INVERSE_DECONV_DEFAULT
Default is Tikhonov deconvolution.
Definition defines.h:536
AF_INVERSE_DECONV_TIKHONOV
@ AF_INVERSE_DECONV_TIKHONOV
Tikhonov Inverse deconvolution.
Definition defines.h:535

## ◆ 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.

528 {
529 AF_ITERATIVE_DECONV_LANDWEBER = 1,
530 AF_ITERATIVE_DECONV_RICHARDSONLUCY = 2,
531 AF_ITERATIVE_DECONV_DEFAULT = 0
532} af_iterative_deconv_algo;
af_iterative_deconv_algo
af_iterative_deconv_algo
Definition defines.h:528
AF_ITERATIVE_DECONV_LANDWEBER
@ AF_ITERATIVE_DECONV_LANDWEBER
Landweber Deconvolution.
Definition defines.h:529
AF_ITERATIVE_DECONV_DEFAULT
@ AF_ITERATIVE_DECONV_DEFAULT
Default is Landweber deconvolution.
Definition defines.h:531
AF_ITERATIVE_DECONV_RICHARDSONLUCY
@ AF_ITERATIVE_DECONV_RICHARDSONLUCY
Richardson-Lucy Deconvolution.
Definition defines.h:530

## ◆ 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.

469 {
470 AF_MARKER_NONE = 0,
471 AF_MARKER_POINT = 1,
472 AF_MARKER_CIRCLE = 2,
473 AF_MARKER_SQUARE = 3,
474 AF_MARKER_TRIANGLE = 4,
475 AF_MARKER_CROSS = 5,
476 AF_MARKER_PLUS = 6,
477 AF_MARKER_STAR = 7
478} af_marker_type;
af_marker_type
af_marker_type
Definition defines.h:469
AF_MARKER_PLUS
@ AF_MARKER_PLUS
Definition defines.h:476
AF_MARKER_CROSS
@ AF_MARKER_CROSS
Definition defines.h:475
AF_MARKER_NONE
@ AF_MARKER_NONE
Definition defines.h:470
AF_MARKER_STAR
@ AF_MARKER_STAR
Definition defines.h:477
AF_MARKER_CIRCLE
@ AF_MARKER_CIRCLE
Definition defines.h:472
AF_MARKER_SQUARE
@ AF_MARKER_SQUARE
Definition defines.h:473
AF_MARKER_POINT
@ AF_MARKER_POINT
Definition defines.h:471
AF_MARKER_TRIANGLE
@ AF_MARKER_TRIANGLE
Definition defines.h:474

## ◆ 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.

348 {
349 AF_MAT_NONE = 0,
350 AF_MAT_TRANS = 1,
351 AF_MAT_CTRANS = 2,
352 AF_MAT_CONJ = 4,
353 AF_MAT_UPPER = 32,
354 AF_MAT_LOWER = 64,
355 AF_MAT_DIAG_UNIT = 128,
356 AF_MAT_SYM = 512,
357 AF_MAT_POSDEF = 1024,
358 AF_MAT_ORTHOG = 2048,
359 AF_MAT_TRI_DIAG = 4096,
360 AF_MAT_BLOCK_DIAG = 8192
361} af_mat_prop;
af_mat_prop
af_mat_prop
Definition defines.h:348
AF_MAT_CONJ
@ AF_MAT_CONJ
Data needs to be conjugate.
Definition defines.h:352
AF_MAT_CTRANS
@ AF_MAT_CTRANS
Data needs to be conjugate tansposed.
Definition defines.h:351
AF_MAT_LOWER
@ AF_MAT_LOWER
Matrix is lower triangular.
Definition defines.h:354
AF_MAT_POSDEF
@ AF_MAT_POSDEF
Matrix is positive definite.
Definition defines.h:357
AF_MAT_UPPER
@ AF_MAT_UPPER
Matrix is upper triangular.
Definition defines.h:353
AF_MAT_SYM
@ AF_MAT_SYM
Matrix is symmetric.
Definition defines.h:356
AF_MAT_ORTHOG
@ AF_MAT_ORTHOG
Matrix is orthogonal.
Definition defines.h:358
AF_MAT_BLOCK_DIAG
@ AF_MAT_BLOCK_DIAG
Matrix is block diagonal.
Definition defines.h:360
AF_MAT_TRI_DIAG
@ AF_MAT_TRI_DIAG
Matrix is tri diagonal.
Definition defines.h:359
AF_MAT_DIAG_UNIT
@ AF_MAT_DIAG_UNIT
Matrix diagonal contains unitary values.
Definition defines.h:355
AF_MAT_TRANS
@ AF_MAT_TRANS
Data needs to be transposed.
Definition defines.h:350
AF_MAT_NONE
@ AF_MAT_NONE
Default.
Definition defines.h:349

## ◆ 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.

319 {
320 AF_SAD = 0,
321 AF_ZSAD,
322 AF_LSAD,
323 AF_SSD,
324 AF_ZSSD,
325 AF_LSSD,
326 AF_NCC,
327 AF_ZNCC,
328 AF_SHD
329} af_match_type;
af_match_type
af_match_type
Definition defines.h:319
AF_LSSD
@ AF_LSSD
Match based on Locally scaled SSD.
Definition defines.h:325
AF_ZNCC
@ AF_ZNCC
Match based on Zero mean NCC.
Definition defines.h:327
AF_ZSAD
@ AF_ZSAD
Match based on Zero mean SAD.
Definition defines.h:321
AF_SSD
@ AF_SSD
Match based on Sum of Squared Differences (SSD)
Definition defines.h:323
AF_NCC
@ AF_NCC
Match based on Normalized Cross Correlation (NCC)
Definition defines.h:326
AF_SHD
@ AF_SHD
Match based on Sum of Hamming Distances (SHD)
Definition defines.h:328
AF_LSAD
@ AF_LSAD
Match based on Locally scaled SAD.
Definition defines.h:322
AF_ZSSD
@ AF_ZSSD
Match based on Zero mean SSD.
Definition defines.h:324
AF_SAD
@ AF_SAD
Match based on Sum of Absolute Differences (SAD)
Definition defines.h:320

## ◆ 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.

395 {
396 AF_MOMENT_M00 = 1,
397 AF_MOMENT_M01 = 2,
398 AF_MOMENT_M10 = 4,
399 AF_MOMENT_M11 = 8,
400 AF_MOMENT_FIRST_ORDER = AF_MOMENT_M00 | AF_MOMENT_M01 | AF_MOMENT_M10 | AF_MOMENT_M11
401} af_moment_type;
af_moment_type
af_moment_type
Definition defines.h:395
AF_MOMENT_M10
@ AF_MOMENT_M10
Definition defines.h:398
AF_MOMENT_M01
@ AF_MOMENT_M01
Definition defines.h:397
AF_MOMENT_M11
@ AF_MOMENT_M11
Definition defines.h:399
AF_MOMENT_FIRST_ORDER
@ AF_MOMENT_FIRST_ORDER
Definition defines.h:400
AF_MOMENT_M00
@ AF_MOMENT_M00
Definition defines.h:396

## ◆ 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.

363 {
364 AF_NORM_VECTOR_1,
365 AF_NORM_VECTOR_INF,
366 AF_NORM_VECTOR_2,
367 AF_NORM_VECTOR_P,
368 AF_NORM_MATRIX_1,
369 AF_NORM_MATRIX_INF,
370 AF_NORM_MATRIX_2,
371 AF_NORM_MATRIX_L_PQ,
372
373 AF_NORM_EUCLID = AF_NORM_VECTOR_2
374} af_norm_type;
af_norm_type
af_norm_type
Definition defines.h:363
AF_NORM_MATRIX_L_PQ
@ AF_NORM_MATRIX_L_PQ
returns Lpq-norm
Definition defines.h:371
AF_NORM_VECTOR_2
@ AF_NORM_VECTOR_2
treats the input as a vector and returns euclidean norm
Definition defines.h:366
AF_NORM_MATRIX_2
@ AF_NORM_MATRIX_2
returns the max singular value). Currently NOT SUPPORTED
Definition defines.h:370
AF_NORM_MATRIX_INF
@ AF_NORM_MATRIX_INF
return the max of row sums
Definition defines.h:369
AF_NORM_EUCLID
@ AF_NORM_EUCLID
The default. Same as AF_NORM_VECTOR_2.
Definition defines.h:373
AF_NORM_VECTOR_P
@ AF_NORM_VECTOR_P
treats the input as a vector and returns the p-norm
Definition defines.h:367
AF_NORM_VECTOR_INF
@ AF_NORM_VECTOR_INF
treats the input as a vector and returns the max of absolute values
Definition defines.h:365
AF_NORM_VECTOR_1
@ AF_NORM_VECTOR_1
treats the input as a vector and returns the sum of absolute values
Definition defines.h:364
AF_NORM_MATRIX_1
@ AF_NORM_MATRIX_1
return the max of column sums
Definition defines.h:368

## ◆ 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.

439 {
440 AF_RANDOM_ENGINE_PHILOX_4X32_10 = 100, //Philox variant with N = 4, W = 32 and Rounds = 10
441 AF_RANDOM_ENGINE_THREEFRY_2X32_16 = 200, //Threefry variant with N = 2, W = 32 and Rounds = 16
442 AF_RANDOM_ENGINE_MERSENNE_GP11213 = 300, //Mersenne variant with MEXP = 11213
443 AF_RANDOM_ENGINE_PHILOX = AF_RANDOM_ENGINE_PHILOX_4X32_10, //Resolves to Philox 4x32_10
444 AF_RANDOM_ENGINE_THREEFRY = AF_RANDOM_ENGINE_THREEFRY_2X32_16, //Resolves to Threefry 2X32_16
445 AF_RANDOM_ENGINE_MERSENNE = AF_RANDOM_ENGINE_MERSENNE_GP11213, //Resolves to Mersenne GP 11213
446 AF_RANDOM_ENGINE_DEFAULT = AF_RANDOM_ENGINE_PHILOX //Resolves to Philox
447} af_random_engine_type;
af_random_engine_type
af_random_engine_type
Definition defines.h:439
AF_RANDOM_ENGINE_PHILOX
@ AF_RANDOM_ENGINE_PHILOX
Definition defines.h:443
AF_RANDOM_ENGINE_DEFAULT
@ AF_RANDOM_ENGINE_DEFAULT
Definition defines.h:446
AF_RANDOM_ENGINE_MERSENNE_GP11213
@ AF_RANDOM_ENGINE_MERSENNE_GP11213
Definition defines.h:442
AF_RANDOM_ENGINE_THREEFRY
@ AF_RANDOM_ENGINE_THREEFRY
Definition defines.h:444
AF_RANDOM_ENGINE_PHILOX_4X32_10
@ AF_RANDOM_ENGINE_PHILOX_4X32_10
Definition defines.h:440
AF_RANDOM_ENGINE_MERSENNE
@ AF_RANDOM_ENGINE_MERSENNE
Definition defines.h:445
AF_RANDOM_ENGINE_THREEFRY_2X32_16
@ AF_RANDOM_ENGINE_THREEFRY_2X32_16
Definition defines.h:441

## ◆ af_someenum_t

enum af_someenum_t

Enumerator
AF_ID |

Definition at line 425 of file defines.h.

425 {
426 AF_ID = 0
427} af_someenum_t;
af_someenum_t
af_someenum_t
Definition defines.h:425
AF_ID
@ AF_ID
Definition defines.h:426

## ◆ af_source

enum af_source

Enumerator
afDevice | Device pointer.
afHost | Host pointer.

Definition at line 232 of file defines.h.

232 {
233 afDevice,
234 afHost
235} af_source;
af_source
af_source
Definition defines.h:232
afDevice
@ afDevice
Device pointer.
Definition defines.h:233
afHost
@ afHost
Host pointer.
Definition defines.h:234

## ◆ 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.

490 {
491 AF_STORAGE_DENSE = 0,
492 AF_STORAGE_CSR = 1,
493 AF_STORAGE_CSC = 2,
494 AF_STORAGE_COO = 3
495} af_storage;
af_storage
af_storage
Definition defines.h:490
AF_STORAGE_CSC
@ AF_STORAGE_CSC
Storage type is CSC.
Definition defines.h:493
AF_STORAGE_CSR
@ AF_STORAGE_CSR
Storage type is CSR.
Definition defines.h:492
AF_STORAGE_COO
@ AF_STORAGE_COO
Storage type is COO.
Definition defines.h:494
AF_STORAGE_DENSE
@ AF_STORAGE_DENSE
Storage type is dense.
Definition defines.h:491

## ◆ 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.

511 {
512 AF_TOPK_MIN = 1,
513 AF_TOPK_MAX = 2,
514 AF_TOPK_STABLE = 4,
515 AF_TOPK_STABLE_MIN = AF_TOPK_STABLE | AF_TOPK_MIN,
516 AF_TOPK_STABLE_MAX = AF_TOPK_STABLE | AF_TOPK_MAX,
517 AF_TOPK_DEFAULT = 0
518} af_topk_function;
af_topk_function
af_topk_function
Definition defines.h:511
AF_TOPK_STABLE_MAX
@ AF_TOPK_STABLE_MAX
Top k max with stable indices.
Definition defines.h:516
AF_TOPK_STABLE
@ AF_TOPK_STABLE
Preserve order of indices for equal values.
Definition defines.h:514
AF_TOPK_MIN
@ AF_TOPK_MIN
Top k min values.
Definition defines.h:512
AF_TOPK_MAX
@ AF_TOPK_MAX
Top k max values.
Definition defines.h:513
AF_TOPK_DEFAULT
@ AF_TOPK_DEFAULT
Default option (max)
Definition defines.h:517
AF_TOPK_STABLE_MIN
@ AF_TOPK_STABLE_MIN
Top k min with stable indices.
Definition defines.h:515

## ◆ 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.

522 {
523 AF_VARIANCE_DEFAULT = 0,
524 AF_VARIANCE_SAMPLE = 1,
525 AF_VARIANCE_POPULATION = 2
526} af_var_bias;
af_var_bias
af_var_bias
Definition defines.h:522
AF_VARIANCE_DEFAULT
@ AF_VARIANCE_DEFAULT
Default (Population) variance.
Definition defines.h:523
AF_VARIANCE_SAMPLE
@ AF_VARIANCE_SAMPLE
Sample variance.
Definition defines.h:524
AF_VARIANCE_POPULATION
@ AF_VARIANCE_POPULATION
Population variance.
Definition defines.h:525

## ◆ 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.

332 {
333 AF_YCC_601 = 601,
334 AF_YCC_709 = 709,
335 AF_YCC_2020 = 2020
336} af_ycc_std;
af_ycc_std
af_ycc_std
Definition defines.h:332
AF_YCC_709
@ AF_YCC_709
ITU-R BT.709 standard.
Definition defines.h:334
AF_YCC_2020
@ AF_YCC_2020
ITU-R BT.2020 standard.
Definition defines.h:335
AF_YCC_601
@ AF_YCC_601
ITU-R BT.601 (formerly CCIR 601) standard.
Definition defines.h:333