defines.h
Go to the documentation of this file.
1 /*******************************************************
2  * Copyright (c) 2014, ArrayFire
3  * All rights reserved.
4  *
5  * This file is distributed under 3-clause BSD license.
6  * The complete license agreement can be obtained at:
7  * http://arrayfire.com/licenses/BSD-3-Clause
8  ********************************************************/
9 
10 #pragma once
11 
12 #if defined(_WIN32) || defined(_MSC_VER)
13  // http://msdn.microsoft.com/en-us/library/b0084kay(v=VS.80).aspx
14  // http://msdn.microsoft.com/en-us/library/3y1sfaz2%28v=VS.80%29.aspx
15  #ifdef AFDLL // libaf
16  #define AFAPI __declspec(dllexport)
17  #else
18  #define AFAPI __declspec(dllimport)
19  #endif
20 
21 // bool
22  #ifndef __cplusplus
23  #define bool unsigned char
24  #define false 0
25  #define true 1
26  #endif
27  #define __PRETTY_FUNCTION__ __FUNCSIG__
28  #define SIZE_T_FRMT_SPECIFIER "%Iu"
29  #define DEPRECATED(msg) __declspec(deprecated( msg ))
30 #else
31  #define AFAPI __attribute__((visibility("default")))
32  #include <stdbool.h>
33  #define SIZE_T_FRMT_SPECIFIER "%zu"
34 #if __GNUC__ >= 4 && __GNUC_MINOR > 4
35  #define DEPRECATED(msg) __attribute__((deprecated( msg )))
36 #else
37  #define DEPRECATED(msg) __attribute__((deprecated))
38 #endif
39 
40 #endif
41 
42 // Known 64-bit x86 and ARM architectures use long long
43 #if defined(__x86_64__) || defined(_M_X64) || defined(_WIN64) || defined(__aarch64__) || defined(__LP64__) // 64-bit Architectures
44  typedef long long dim_t;
45 // Known 32-bit x86 and ARM architectures use int
46 #elif defined(__i386__) || defined(_M_IX86) || defined(__arm__) || defined(_M_ARM) // 32-bit x86 Architecture
47  typedef int dim_t;
48 // All other platforms use long long
49 #else
50  typedef long long dim_t;
51 #endif
52 
53 #include <stdlib.h>
54 
55 typedef long long intl;
56 typedef unsigned long long uintl;
57 
58 #include <af/version.h>
59 #ifndef AF_API_VERSION
60 #define AF_API_VERSION AF_API_VERSION_CURRENT
61 #endif
62 
63 typedef enum {
68 
69  // 100-199 Errors in environment
70 
75 
80 
85 
86  // 200-299 Errors in input parameters
87 
92 
96  AF_ERR_ARG = 202,
97 
101  AF_ERR_SIZE = 203,
102 
106  AF_ERR_TYPE = 204,
107 
112 
117 
118 
119 #if AF_API_VERSION >= 33
120  AF_ERR_DEVICE = 208,
124 #endif
125 
126  // 300-399 Errors for missing software features
127 
132 
137 
138 #if AF_API_VERSION >= 32
139  AF_ERR_NONFREE = 303,
143 #endif
144 
145  // 400-499 Errors for missing hardware features
146 
151 
157 
158  // 500-599 Errors specific to heterogenous API
159 
160 #if AF_API_VERSION >= 32
161  AF_ERR_LOAD_LIB = 501,
165 #endif
166 
167 #if AF_API_VERSION >= 32
168  AF_ERR_LOAD_SYM = 502,
172 #endif
173 
174 #if AF_API_VERSION >= 32
179 #endif
180 
181  // 900-999 Errors from upstream libraries and runtimes
182 
188 
193 } af_err;
194 
195 typedef enum {
196  f32,
197  c32,
198  f64,
199  c64,
200  b8 ,
201  s32,
202  u32,
203  u8 ,
204  s64,
205  u64,
206 #if AF_API_VERSION >= 32
207  s16,
208 #endif
209 #if AF_API_VERSION >= 32
210  u16,
211 #endif
212 } af_dtype;
213 
214 typedef enum {
217 } af_source;
218 
219 #define AF_MAX_DIMS 4
220 
221 // A handle for an internal array object
222 typedef void * af_array;
223 
224 typedef enum {
230 #if AF_API_VERSION >= 34
232 #endif
233 #if AF_API_VERSION >= 34
235 #endif
236 #if AF_API_VERSION >= 34
238 #endif
239 #if AF_API_VERSION >= 34
241 #endif
242 #if AF_API_VERSION >= 34
244 #endif
245 
247 
248 typedef enum {
253 
259 
260 typedef enum {
265 
271 
272 typedef enum {
273 
278 
283 } af_conv_mode;
284 
285 typedef enum {
290 
291 typedef enum {
292  AF_SAD = 0,
301 } af_match_type;
302 
303 #if AF_API_VERSION >= 31
304 typedef enum {
305  AF_YCC_601 = 601,
306  AF_YCC_709 = 709,
307  AF_YCC_2020 = 2020
308 } af_ycc_std;
309 #endif
310 
311 typedef enum {
312  AF_GRAY = 0,
315 #if AF_API_VERSION >= 31
317 #endif
318 } af_cspace_t;
319 
320 typedef enum {
328  AF_MAT_SYM = 512,
329  AF_MAT_POSDEF = 1024,
330  AF_MAT_ORTHOG = 2048,
333 } af_mat_prop;
334 
335 typedef enum {
344 
346 } af_norm_type;
347 
348 #if AF_API_VERSION >= 31
349 typedef enum {
354  AF_FIF_PNG = 13,
355  AF_FIF_PPM = 14,
357  AF_FIF_TIFF = 18,
358  AF_FIF_PSD = 20,
359  AF_FIF_HDR = 26,
360  AF_FIF_EXR = 29,
361  AF_FIF_JP2 = 31,
364 #endif
365 
366 #if AF_API_VERSION >=34
367 typedef enum {
374 #endif
375 
376 #if AF_API_VERSION >= 32
377 typedef enum {
381 #endif
382 
383 #if AF_API_VERSION >= 32
384 // These enums should be 2^x
385 typedef enum {
390 } af_backend;
391 #endif
392 
393 // Below enum is purely added for example purposes
394 // it doesn't and shoudn't be used anywhere in the
395 // code. No Guarantee's provided if it is used.
396 typedef enum {
397  AF_ID = 0
398 } af_someenum_t;
399 
400 #if AF_API_VERSION >=34
401 typedef enum {
406 } af_binary_op;
407 #endif
408 
409 #if AF_API_VERSION >=34
410 typedef enum {
411  AF_RANDOM_ENGINE_PHILOX_4X32_10 = 100, //Philox variant with N = 4, W = 32 and Rounds = 10
412  AF_RANDOM_ENGINE_THREEFRY_2X32_16 = 200, //Threefry variant with N = 2, W = 32 and Rounds = 16
413  AF_RANDOM_ENGINE_MERSENNE_GP11213 = 300, //Mersenne variant with MEXP = 11213
419 #endif
420 
422 // FORGE / Graphics Related Enums
423 // These enums have values corresponsding to Forge enums in forge defines.h
425 typedef enum {
437 } af_colormap;
438 
439 #if AF_API_VERSION >= 32
440 typedef enum {
450 #endif
451 
453 #if AF_API_VERSION >= 35
454 typedef enum {
458 #endif
459 
460 #if AF_API_VERSION >= 34
461 typedef enum {
466 } af_storage;
467 #endif
468 
469 #if AF_API_VERSION >= 36
470 typedef enum {
475 
476 typedef enum {
481 
482 typedef enum {
487 #endif
488 
489 #ifdef __cplusplus
490 namespace af
491 {
492  typedef af_dtype dtype;
493  typedef af_source source;
499  typedef af_someenum_t SomeEnum; // Purpose of Addition: How to add Function example
506 #if AF_API_VERSION >= 31
508 #endif
509 #if AF_API_VERSION >= 31
511 #endif
512 #if AF_API_VERSION >= 32
514 #endif
515 #if AF_API_VERSION >= 32
517 #endif
518 #if AF_API_VERSION >= 34
520 #endif
521 #if AF_API_VERSION >= 34
523 #endif
524 #if AF_API_VERSION >= 34
526 #endif
527 #if AF_API_VERSION >= 34
529 #endif
530 #if AF_API_VERSION >= 35
532 #endif
533 #if AF_API_VERSION >= 36
537 #endif
538 }
539 
540 #endif
af_canny_threshold
Definition: defines.h:454
The system or device ran out of memory.
Definition: defines.h:74
af_source source
Definition: defines.h:493
af_random_engine_type
Definition: defines.h:410
Determine canny algorithm thresholds using Otsu algorithm.
Definition: defines.h:456
Gradient diffusion equation.
Definition: defines.h:477
af_flux_function
Definition: defines.h:470
af_ycc_std
Definition: defines.h:304
Matrix is symmetric.
Definition: defines.h:328
returns the max singular value). Currently NOT SUPPORTED
Definition: defines.h:342
Match based on Sum of Squared Differences (SSD)
Definition: defines.h:295
af_someenum_t SomeEnum
Definition: defines.h:499
af_backend
Definition: defines.h:385
af_colormap ColorMap
Definition: defines.h:504
Cubic Interpolation.
Definition: defines.h:228
Matrix is orthogonal.
Definition: defines.h:330
Linear Interpolation.
Definition: defines.h:226
Definition: algorithm.h:14
Definition: defines.h:397
Device pointer.
Definition: defines.h:215
FreeImage Enum for RAW Camera Image File.
Definition: defines.h:362
Perceptually uniform shades of black-red-yellow.
Definition: defines.h:433
FreeImage Enum for JPEG Network Graphics File.
Definition: defines.h:353
CPU a.k.a sequential algorithms.
Definition: defines.h:387
af_topk_function topkFunction
Definition: defines.h:536
The function returned successfully.
Definition: defines.h:67
af_norm_type
Definition: defines.h:335
af_border_type
Definition: defines.h:248
ITU-R BT.709 standard.
Definition: defines.h:306
The type of the input arrays are not compatible.
Definition: defines.h:111
Output of the convolution is signal_len + filter_len - 1.
Definition: defines.h:282
af_canny_threshold cannyThreshold
Definition: defines.h:531
FreeImage Enum for Bitmap File.
Definition: defines.h:350
Blue hue map.
Definition: defines.h:432
Matrix is upper triangular.
Definition: defines.h:325
Bilinear Interpolation with cosine smoothing.
Definition: defines.h:234
3-channel YCbCr
Definition: defines.h:316
Matrix diagonal contains unitary values.
Definition: defines.h:327
Output of the convolution is the same size as input.
Definition: defines.h:277
Mood map.
Definition: defines.h:430
32-bit signed integral values
Definition: defines.h:201
Function does not support GFOR / batch mode.
Definition: defines.h:116
af_ycc_std YCCStd
Definition: defines.h:507
af_diffusion_eq diffusionEq
Definition: defines.h:535
Matrix is positive definite.
Definition: defines.h:329
The option is not supported.
Definition: defines.h:131
FreeImage Enum for Windows Icon File.
Definition: defines.h:351
Default backend order: OpenCL -> CUDA -> CPU.
Definition: defines.h:386
CUDA Compute Backend.
Definition: defines.h:388
Match based on Zero mean SAD.
Definition: defines.h:293
User has to define canny thresholds manually.
Definition: defines.h:455
64-bit signed integral values
Definition: defines.h:204
16-bit signed integral values
Definition: defines.h:207
Match based on Zero mean SSD.
Definition: defines.h:296
Grayscale.
Definition: defines.h:312
Bicubic Interpolation with Catmull-Rom splines.
Definition: defines.h:243
Match based on Zero mean NCC.
Definition: defines.h:299
16-bit unsigned integral values
Definition: defines.h:210
af_backend Backend
Definition: defines.h:513
Default.
Definition: defines.h:321
af_interp_type
Definition: defines.h:224
Match based on Locally scaled SSD.
Definition: defines.h:297
Perceptually uniform shades of blue-red-yellow.
Definition: defines.h:435
af_binary_op binaryOp
Definition: defines.h:525
Bicubic Interpolation.
Definition: defines.h:237
af_random_engine_type randomEngineType
Definition: defines.h:528
FreeImage Enum for JPEG File.
Definition: defines.h:352
Data needs to be conjugate tansposed.
Definition: defines.h:323
64-bit complex floating point values
Definition: defines.h:198
There was an error when loading the symbols.
Definition: defines.h:171
Match based on Normalized Cross Correlation (NCC)
Definition: defines.h:298
treats the input as a vector and returns the p-norm
Definition: defines.h:339
af_storage
Definition: defines.h:461
af_image_format imageFormat
Definition: defines.h:510
af_homography_type
Definition: defines.h:377
af_conv_domain
Definition: defines.h:285
FreeImage Enum for Adobe Photoshop File.
Definition: defines.h:358
af_colormap
Definition: defines.h:425
Computes homography using Least Median of Squares.
Definition: defines.h:379
Data needs to be conjugate.
Definition: defines.h:324
return the max of row sums
Definition: defines.h:341
FreeImage Enum for Portable Pixelmap (ASCII) File.
Definition: defines.h:355
There was an error with the runtime environment.
Definition: defines.h:84
Out of bound values are symmetric over the edge.
Definition: defines.h:257
Storage type is CSC.
Definition: defines.h:464
Spectrum map (390nm-830nm, in sRGB colorspace)
Definition: defines.h:427
3-channel HSV
Definition: defines.h:314
af_connectivity
Definition: defines.h:260
Computes homography using RANSAC.
Definition: defines.h:378
returns Lpq-norm
Definition: defines.h:343
FreeImage Enum for JPEG-2000 File.
Definition: defines.h:361
af_err
Definition: defines.h:63
Match based on Locally scaled SAD.
Definition: defines.h:294
The type is not suppported by this function.
Definition: defines.h:106
af_source
Definition: defines.h:214
Connectivity includes neighbors, North, East, South and West of current pixel.
Definition: defines.h:264
64-bit unsigned integral values
Definition: defines.h:205
af_someenum_t
Definition: defines.h:396
af_conv_mode
Definition: defines.h:272
Storage type is CSR.
Definition: defines.h:463
af_storage storage
Definition: defines.h:522
ITU-R BT.601 (formerly CCIR 601) standard.
Definition: defines.h:305
Out of bound values are 0.
Definition: defines.h:252
Bilinear Interpolation.
Definition: defines.h:227
This device does not support double.
Definition: defines.h:150
Storage type is COO.
Definition: defines.h:465
64-bit complex floating point values
Definition: defines.h:199
long long dim_t
Definition: defines.h:50
This build of ArrayFire was not built with graphics or this device does not support graphics...
Definition: defines.h:156
There was an error when loading the libraries.
Definition: defines.h:164
OpenCL Compute Backend.
Definition: defines.h:389
This build of ArrayFire does not support this feature.
Definition: defines.h:136
There was a mismatch between the input array and the active backend.
Definition: defines.h:178
af_marker_type
Definition: defines.h:440
af_diffusion_eq
Definition: defines.h:476
Cubic Interpolation with Catmull-Rom splines.
Definition: defines.h:240
FreeImage Enum for Tagged Image File Format File.
Definition: defines.h:357
ArrayFire automatically picks the right convolution algorithm.
Definition: defines.h:286
32-bit complex floating point values
Definition: defines.h:197
af_mat_prop matProp
Definition: defines.h:503
af_norm_type normType
Definition: defines.h:505
treats the input as a vector and returns the max of absolute values
Definition: defines.h:337
Matrix is block diagonal.
Definition: defines.h:332
There was an error in the device driver.
Definition: defines.h:79
Connectivity includes 4-connectivity neigbors and also those on Northeast, Northwest, Southeast and Southwest.
Definition: defines.h:269
This build of ArrayFire is not compiled with "nonfree" algorithms.
Definition: defines.h:142
af_conv_domain convDomain
Definition: defines.h:502
af_topk_function
Definition: defines.h:482
The default. Same as AF_NORM_VECTOR_2.
Definition: defines.h:345
Modified curvature diffusion equation.
Definition: defines.h:478
Top k max values.
Definition: defines.h:484
8-bit unsigned integral values
Definition: defines.h:203
af_border_type borderType
Definition: defines.h:495
FreeImage Enum for ILM OpenEXR File.
Definition: defines.h:360
Perform convolution in spatial domain.
Definition: defines.h:287
af_binary_op
Definition: defines.h:401
Perform convolution in frequency domain.
Definition: defines.h:288
Match based on Sum of Hamming Distances (SHD)
Definition: defines.h:300
Match based on Sum of Absolute Differences (SAD)
Definition: defines.h:292
Data needs to be transposed.
Definition: defines.h:322
return the max of column sums
Definition: defines.h:340
af_mat_prop trans
Definition: defines.h:500
One of the function arguments is incorrect.
Definition: defines.h:96
Nearest Interpolation.
Definition: defines.h:225
unsigned long long uintl
Definition: defines.h:56
Perceptually uniform shades of blue-green-yellow.
Definition: defines.h:436
3-channel RGB
Definition: defines.h:313
af_mat_prop
Definition: defines.h:320
Linear Interpolation with cosine smoothing.
Definition: defines.h:231
Exponential flux function.
Definition: defines.h:472
The input array is not a valid af_array object.
Definition: defines.h:91
32-bit unsigned integral values
Definition: defines.h:202
FreeImage Enum for High Dynamic Range File.
Definition: defines.h:359
af_cspace_t
Definition: defines.h:311
Default grayscale map.
Definition: defines.h:426
Default option is same as AF_DIFFUSION_GRAD.
Definition: defines.h:479
Matrix is lower triangular.
Definition: defines.h:326
FreeImage Enum for Portable Network Graphics File.
Definition: defines.h:354
FreeImage Enum for Portable Pixelmap (Binary) File.
Definition: defines.h:356
void * af_array
Definition: defines.h:222
Perceptually uniform shades of black-red-white.
Definition: defines.h:434
af_image_format
Definition: defines.h:349
af_match_type matchType
Definition: defines.h:497
af_moment_type
Definition: defines.h:367
Matrix is tri diagonal.
Definition: defines.h:331
Top k min values.
Definition: defines.h:483
af_cspace_t CSpace
Definition: defines.h:498
32-bit floating point values
Definition: defines.h:196
treats the input as a vector and returns euclidean norm
Definition: defines.h:338
Heat map.
Definition: defines.h:431
Input does not belong to the current device.
Definition: defines.h:123
af_flux_function fluxFunction
Definition: defines.h:534
treats the input as a vector and returns the sum of absolute values
Definition: defines.h:336
8-bit boolean values
Definition: defines.h:200
Default option (max)
Definition: defines.h:485
Floor Indexed.
Definition: defines.h:229
Storage type is dense.
Definition: defines.h:462
Host pointer.
Definition: defines.h:216
Quadratic flux function.
Definition: defines.h:471
af_marker_type markerType
Definition: defines.h:516
af_dtype
Definition: defines.h:195
af_interp_type interpType
Definition: defines.h:494
af_match_type
Definition: defines.h:291
Red hue map.
Definition: defines.h:429
There was an internal error either in ArrayFire or in a project upstream.
Definition: defines.h:187
af_moment_type momentType
Definition: defines.h:519
af_conv_mode convMode
Definition: defines.h:501
Unknown Error.
Definition: defines.h:192
af_dtype dtype
Definition: defines.h:492
long long intl
Definition: defines.h:55
Colors, aka. Rainbow.
Definition: defines.h:428
The size is incorrect.
Definition: defines.h:101
Default flux function is exponential.
Definition: defines.h:473
af_connectivity connectivity
Definition: defines.h:496
ITU-R BT.2020 standard.
Definition: defines.h:307