defines.h Source File

- Main Page
- Tutorials
- Functions
- Release Notes
- Examples

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 #if defined(__x86_64__) || defined(_M_X64) || defined(__i386__) || defined(_M_IX86) || defined(_WIN64)
54 #define USE_CPUID
55 #endif
56
57 #include <stdlib.h>
58
59 typedef long long intl;
60 typedef unsigned long long uintl;
61
62 #include <af/version.h>
63 #ifndef AF_API_VERSION
64 #define AF_API_VERSION AF_API_VERSION_CURRENT
65 #endif
66
67 typedef enum {
71 AF_SUCCESS = 0,
72
73 // 100-199 Errors in environment
74
78 AF_ERR_NO_MEM = 101,
79
83 AF_ERR_DRIVER = 102,
84
88 AF_ERR_RUNTIME = 103,
89
90 // 200-299 Errors in input parameters
91
95 AF_ERR_INVALID_ARRAY = 201,
96
100 AF_ERR_ARG = 202,
101
105 AF_ERR_SIZE = 203,
106
110 AF_ERR_TYPE = 204,
111
115 AF_ERR_DIFF_TYPE = 205,
116
120 AF_ERR_BATCH = 207,
121
122
123 // 300-399 Errors for missing software features
124
128 AF_ERR_NOT_SUPPORTED = 301,
129
133 AF_ERR_NOT_CONFIGURED = 302,
134
135 #if AF_API_VERSION >= 32
136 AF_ERR_NONFREE = 303,
140 #endif
141
142 // 400-499 Errors for missing hardware features
143
147 AF_ERR_NO_DBL = 401,
148
153 AF_ERR_NO_GFX = 402,
154
155 // 500-599 Errors specific to heterogenous API
156
157 #if AF_API_VERSION >= 32
158 AF_ERR_LOAD_LIB = 501,
162 #endif
163
164 #if AF_API_VERSION >= 32
165 AF_ERR_LOAD_SYM = 502,
169 #endif
170
171 #if AF_API_VERSION >= 32
172 AF_ERR_ARR_BKND_MISMATCH = 503,
176 #endif
177
178 // 900-999 Errors from upstream libraries and runtimes
179
184 AF_ERR_INTERNAL = 998,
185
189 AF_ERR_UNKNOWN = 999
190 } af_err;
191
192 typedef enum {
193 f32,
194 c32,
195 f64,
196 c64,
197 b8 ,
198 s32,
199 u32,
200 u8 ,
201 s64,
202 u64,
203 #if AF_API_VERSION >= 32
204 s16,
205 #endif
206 #if AF_API_VERSION >= 32
207 u16,
208 #endif
209 } af_dtype;
210
211 typedef enum {
212 afDevice,
213 afHost,
214 } af_source;
215
216 #define AF_MAX_DIMS 4
217
218 // A handle for an internal array object
219 typedef void * af_array;
220
221 typedef enum {
222 AF_INTERP_NEAREST,
223 AF_INTERP_LINEAR,
224 AF_INTERP_BILINEAR,
225 AF_INTERP_CUBIC,
226 AF_INTERP_LOWER
227 } af_interp_type;
228
229 typedef enum {
233 AF_PAD_ZERO = 0,
234
238 AF_PAD_SYM
239 } af_border_type;
240
241 typedef enum {
245 AF_CONNECTIVITY_4 = 4,
246
250 AF_CONNECTIVITY_8 = 8
251 } af_connectivity;
252
253 typedef enum {
254
258 AF_CONV_DEFAULT,
259
263 AF_CONV_EXPAND,
264 } af_conv_mode;
265
266 typedef enum {
267 AF_CONV_AUTO,
268 AF_CONV_SPATIAL,
269 AF_CONV_FREQ,
270 } af_conv_domain;
271
272 typedef enum {
273 AF_SAD = 0,
274 AF_ZSAD,
275 AF_LSAD,
276 AF_SSD,
277 AF_ZSSD,
278 AF_LSSD,
279 AF_NCC,
280 AF_ZNCC,
281 AF_SHD
282 } af_match_type;
283
284 #if AF_API_VERSION >= 31
285 typedef enum {
286 AF_YCC_601 = 601,
287 AF_YCC_709 = 709,
288 AF_YCC_2020 = 2020
289 } af_ycc_std;
290 #endif
291
292 typedef enum {
293 AF_GRAY = 0,
294 AF_RGB,
295 AF_HSV,
296 #if AF_API_VERSION >= 31
297 AF_YCbCr
298 #endif
299 } af_cspace_t;
300
301 typedef enum {
302 AF_MAT_NONE = 0,
303 AF_MAT_TRANS = 1,
304 AF_MAT_CTRANS = 2,
305 AF_MAT_CONJ = 4,
306 AF_MAT_UPPER = 32,
307 AF_MAT_LOWER = 64,
308 AF_MAT_DIAG_UNIT = 128,
309 AF_MAT_SYM = 512,
310 AF_MAT_POSDEF = 1024,
311 AF_MAT_ORTHOG = 2048,
312 AF_MAT_TRI_DIAG = 4096,
313 AF_MAT_BLOCK_DIAG = 8192
314 } af_mat_prop;
315
316 typedef enum {
317 AF_NORM_VECTOR_1,
318 AF_NORM_VECTOR_INF,
319 AF_NORM_VECTOR_2,
320 AF_NORM_VECTOR_P,
321 AF_NORM_MATRIX_1,
322 AF_NORM_MATRIX_INF,
323 AF_NORM_MATRIX_2,
324 AF_NORM_MATRIX_L_PQ,
325
326 AF_NORM_EUCLID = AF_NORM_VECTOR_2,
327 } af_norm_type;
328
329 typedef enum {
330 AF_COLORMAP_DEFAULT = 0,
331 AF_COLORMAP_SPECTRUM= 1,
332 AF_COLORMAP_COLORS = 2,
333 AF_COLORMAP_RED = 3,
334 AF_COLORMAP_MOOD = 4,
335 AF_COLORMAP_HEAT = 5,
336 AF_COLORMAP_BLUE = 6
337 } af_colormap;
338
339 #if AF_API_VERSION >= 31
340 typedef enum {
341 AF_FIF_BMP = 0,
342 AF_FIF_ICO = 1,
343 AF_FIF_JPEG = 2,
344 AF_FIF_JNG = 3,
345 AF_FIF_PNG = 13,
346 AF_FIF_PPM = 14,
347 AF_FIF_PPMRAW = 15,
348 AF_FIF_TIFF = 18,
349 AF_FIF_PSD = 20,
350 AF_FIF_HDR = 26,
351 AF_FIF_EXR = 29,
352 AF_FIF_JP2 = 31,
353 AF_FIF_RAW = 34
354 } af_image_format;
355 #endif
356
357 #if AF_API_VERSION >= 32
358 typedef enum {
359 AF_HOMOGRAPHY_RANSAC = 0,
360 AF_HOMOGRAPHY_LMEDS = 1
361 } af_homography_type;
362 #endif
363
364 #if AF_API_VERSION >= 32
365 // These enums should be 2^x
366 typedef enum {
367 AF_BACKEND_DEFAULT = 0,
368 AF_BACKEND_CPU = 1,
369 AF_BACKEND_CUDA = 2,
370 AF_BACKEND_OPENCL = 4,
371 } af_backend;
372 #endif
373
374 // Below enum is purely added for example purposes
375 // it doesn't and shoudn't be used anywhere in the
376 // code. No Guarantee's provided if it is used.
377 typedef enum {
378 AF_ID = 0
379 } af_someenum_t;
380
381 #ifdef __cplusplus
382 namespace af
383 {
384 typedef af_dtype dtype;
385 typedef af_source source;
386 typedef af_interp_type interpType;
387 typedef af_border_type borderType;
388 typedef af_connectivity connectivity;
389 typedef af_match_type matchType;
390 typedef af_cspace_t CSpace;
391 typedef af_someenum_t SomeEnum; // Purpose of Addition: How to add Function example
392 typedef af_mat_prop trans;
393 typedef af_conv_mode convMode;
394 typedef af_conv_domain convDomain;
395 typedef af_mat_prop matProp;
396 typedef af_colormap ColorMap;
397 typedef af_norm_type normType;
398 #if AF_API_VERSION >= 31
399 typedef af_ycc_std YCCStd;
400 #endif
401 #if AF_API_VERSION >= 31
402 typedef af_image_format imageFormat;
403 #endif
404 #if AF_API_VERSION >= 32
405 typedef af_backend Backend;
406 #endif
407 }
408
409 #endif
AF_ERR_NO_MEM
The system or device ran out of memory.
Definition: defines.h:78
af::source
af_source source
Definition: defines.h:385
af_ycc_std
af_ycc_std
Definition: defines.h:285
AF_MAT_SYM
Matrix is symmetric.
Definition: defines.h:309
AF_NORM_MATRIX_2
returns the max singular value). Currently NOT SUPPORTED
Definition: defines.h:323
AF_SSD
Match based on Sum of Squared Differences (SSD)
Definition: defines.h:276
af::SomeEnum
af_someenum_t SomeEnum
Definition: defines.h:391
af_backend
af_backend
Definition: defines.h:366
af::ColorMap
af_colormap ColorMap
Definition: defines.h:396
AF_INTERP_CUBIC
Cubic Interpolation.
Definition: defines.h:225
AF_MAT_ORTHOG
Matrix is orthogonal.
Definition: defines.h:311
AF_INTERP_LINEAR
Linear Interpolation.
Definition: defines.h:223
af
Definition: algorithm.h:14
AF_ID
Definition: defines.h:378
afDevice
Device pointer.
Definition: defines.h:212
AF_FIF_RAW
FreeImage Enum for RAW Camera Image File.
Definition: defines.h:353
AF_FIF_JNG
FreeImage Enum for JPEG Network Graphics File.
Definition: defines.h:344
AF_BACKEND_CPU
CPU a.k.a sequential algorithms.
Definition: defines.h:368
AF_SUCCESS
The function returned successfully.
Definition: defines.h:71
af_norm_type
af_norm_type
Definition: defines.h:316
af_border_type
af_border_type
Definition: defines.h:229
AF_YCC_709
ITU-R BT.709 standard.
Definition: defines.h:287
AF_ERR_DIFF_TYPE
The type of the input arrays are not compatible.
Definition: defines.h:115
AF_CONV_EXPAND
Output of the convolution is signal_len + filter_len - 1.
Definition: defines.h:263
AF_FIF_BMP
FreeImage Enum for Bitmap File.
Definition: defines.h:341
AF_COLORMAP_BLUE
Blue hue map.
Definition: defines.h:336
AF_MAT_UPPER
Matrix is upper triangular.
Definition: defines.h:306
AF_YCbCr
3-channel YCbCr
Definition: defines.h:297
AF_MAT_DIAG_UNIT
Matrix diagonal contains unitary values.
Definition: defines.h:308
AF_CONV_DEFAULT
Output of the convolution is the same size as input.
Definition: defines.h:258
AF_COLORMAP_MOOD
Mood map.
Definition: defines.h:334
s32
32-bit signed integral values
Definition: defines.h:198
AF_ERR_BATCH
Function does not support GFOR / batch mode.
Definition: defines.h:120
af::YCCStd
af_ycc_std YCCStd
Definition: defines.h:399
AF_MAT_POSDEF
Matrix is positive definite.
Definition: defines.h:310
AF_ERR_NOT_SUPPORTED
The option is not supported.
Definition: defines.h:128
AF_FIF_ICO
FreeImage Enum for Windows Icon File.
Definition: defines.h:342
AF_BACKEND_DEFAULT
Default backend order: OpenCL -> CUDA -> CPU.
Definition: defines.h:367
AF_BACKEND_CUDA
CUDA Compute Backend.
Definition: defines.h:369
AF_ZSAD
Match based on Zero mean SAD.
Definition: defines.h:274
s64
64-bit signed integral values
Definition: defines.h:201
s16
16-bit signed integral values
Definition: defines.h:204
AF_ZSSD
Match based on Zero mean SSD.
Definition: defines.h:277
AF_GRAY
Grayscale.
Definition: defines.h:293
AF_ZNCC
Match based on Zero mean NCC.
Definition: defines.h:280
u16
16-bit unsigned integral values
Definition: defines.h:207
af::Backend
af_backend Backend
Definition: defines.h:405
AF_MAT_NONE
Default.
Definition: defines.h:302
af_interp_type
af_interp_type
Definition: defines.h:221
AF_LSSD
Match based on Locally scaled SSD.
Definition: defines.h:278
AF_FIF_JPEG
FreeImage Enum for JPEG File.
Definition: defines.h:343
AF_MAT_CTRANS
Data needs to be conjugate tansposed.
Definition: defines.h:304
f64
64-bit complex floating point values
Definition: defines.h:195
AF_ERR_LOAD_SYM
There was an error when loading the symbols.
Definition: defines.h:168
AF_NCC
Match based on Normalized Cross Correlation (NCC)
Definition: defines.h:279
AF_NORM_VECTOR_P
treats the input as a vector and returns the p-norm
Definition: defines.h:320
af::imageFormat
af_image_format imageFormat
Definition: defines.h:402
af_homography_type
af_homography_type
Definition: defines.h:358
af_conv_domain
af_conv_domain
Definition: defines.h:266
AF_FIF_PSD
FreeImage Enum for Adobe Photoshop File.
Definition: defines.h:349
af_colormap
af_colormap
Definition: defines.h:329
AF_HOMOGRAPHY_LMEDS
Computes homography using Least Median of Squares.
Definition: defines.h:360
AF_MAT_CONJ
Data needs to be conjugate.
Definition: defines.h:305
AF_NORM_MATRIX_INF
return the max of row sums
Definition: defines.h:322
AF_FIF_PPM
FreeImage Enum for Portable Pixelmap (ASCII) File.
Definition: defines.h:346
AF_ERR_RUNTIME
There was an error with the runtime environment.
Definition: defines.h:88
AF_PAD_SYM
Out of bound values are symmetric over the edge.
Definition: defines.h:238
AF_COLORMAP_SPECTRUM
Spectrum map.
Definition: defines.h:331
AF_HSV
3-channel HSV
Definition: defines.h:295
af_connectivity
af_connectivity
Definition: defines.h:241
AF_HOMOGRAPHY_RANSAC
Computes homography using RANSAC.
Definition: defines.h:359
AF_NORM_MATRIX_L_PQ
returns Lpq-norm
Definition: defines.h:324
AF_FIF_JP2
FreeImage Enum for JPEG-2000 File.
Definition: defines.h:352
af_err
af_err
Definition: defines.h:67
AF_LSAD
Match based on Locally scaled SAD.
Definition: defines.h:275
AF_ERR_TYPE
The type is not suppported by this function.
Definition: defines.h:110
af_source
af_source
Definition: defines.h:211
AF_CONNECTIVITY_4
Connectivity includes neighbors, North, East, South and West of current pixel.
Definition: defines.h:245
u64
64-bit unsigned integral values
Definition: defines.h:202
af_someenum_t
af_someenum_t
Definition: defines.h:377
af_conv_mode
af_conv_mode
Definition: defines.h:253
AF_YCC_601
ITU-R BT.601 (formerly CCIR 601) standard.
Definition: defines.h:286
AF_PAD_ZERO
Out of bound values are 0.
Definition: defines.h:233
AF_INTERP_BILINEAR
Bilinear Interpolation.
Definition: defines.h:224
AF_ERR_NO_DBL
This device does not support double.
Definition: defines.h:147
c64
64-bit complex floating point values
Definition: defines.h:196
dim_t
long long dim_t
Definition: defines.h:50
AF_ERR_NO_GFX
This build of ArrayFire was not built with graphics or this device does not support graphics...
Definition: defines.h:153
AF_ERR_LOAD_LIB
There was an error when loading the libraries.
Definition: defines.h:161
AF_BACKEND_OPENCL
OpenCL Compute Backend.
Definition: defines.h:370
AF_ERR_NOT_CONFIGURED
This build of ArrayFire does not support this feature.
Definition: defines.h:133
AF_ERR_ARR_BKND_MISMATCH
There was a mismatch between the input array and the active backend.
Definition: defines.h:175
AF_FIF_TIFF
FreeImage Enum for Tagged Image File Format File.
Definition: defines.h:348
AF_CONV_AUTO
ArrayFire automatically picks the right convolution algorithm.
Definition: defines.h:267
c32
32-bit complex floating point values
Definition: defines.h:194
af::matProp
af_mat_prop matProp
Definition: defines.h:395
af::normType
af_norm_type normType
Definition: defines.h:397
AF_NORM_VECTOR_INF
treats the input as a vector and returns the max of absolute values
Definition: defines.h:318
AF_MAT_BLOCK_DIAG
Matrix is block diagonal.
Definition: defines.h:313
AF_ERR_DRIVER
There was an error in the device driver.
Definition: defines.h:83
AF_CONNECTIVITY_8
Connectivity includes 4-connectivity neigbors and also those on Northeast, Northwest, Southeast and Southwest.
Definition: defines.h:250
AF_ERR_NONFREE
This build of ArrayFire is not compiled with "nonfree" algorithms.
Definition: defines.h:139
af::convDomain
af_conv_domain convDomain
Definition: defines.h:394
AF_NORM_EUCLID
The default. Same as AF_NORM_VECTOR_2.
Definition: defines.h:326
u8
8-bit unsigned integral values
Definition: defines.h:200
af::borderType
af_border_type borderType
Definition: defines.h:387
AF_FIF_EXR
FreeImage Enum for ILM OpenEXR File.
Definition: defines.h:351
AF_CONV_SPATIAL
Perform convolution in spatial domain.
Definition: defines.h:268
AF_CONV_FREQ
Perform convolution in frequency domain.
Definition: defines.h:269
AF_SHD
Match based on Sum of Hamming Distances (SHD)
Definition: defines.h:281
AF_SAD
Match based on Sum of Absolute Differences (SAD)
Definition: defines.h:273
AF_MAT_TRANS
Data needs to be transposed.
Definition: defines.h:303
AF_NORM_MATRIX_1
return the max of column sums
Definition: defines.h:321
af::trans
af_mat_prop trans
Definition: defines.h:392
AF_ERR_ARG
One of the function arguments is incorrect.
Definition: defines.h:100
AF_INTERP_NEAREST
Nearest Interpolation.
Definition: defines.h:222
uintl
unsigned long long uintl
Definition: defines.h:60
AF_RGB
3-channel RGB
Definition: defines.h:294
af_mat_prop
af_mat_prop
Definition: defines.h:301
AF_ERR_INVALID_ARRAY
The input array is not a valid af_array object.
Definition: defines.h:95
u32
32-bit unsigned integral values
Definition: defines.h:199
AF_FIF_HDR
FreeImage Enum for High Dynamic Range File.
Definition: defines.h:350
af_cspace_t
af_cspace_t
Definition: defines.h:292
AF_COLORMAP_DEFAULT
Default grayscale map.
Definition: defines.h:330
AF_MAT_LOWER
Matrix is lower triangular.
Definition: defines.h:307
AF_FIF_PNG
FreeImage Enum for Portable Network Graphics File.
Definition: defines.h:345
AF_FIF_PPMRAW
FreeImage Enum for Portable Pixelmap (Binary) File.
Definition: defines.h:347
af_array
void * af_array
Definition: defines.h:219
af_image_format
af_image_format
Definition: defines.h:340
af::matchType
af_match_type matchType
Definition: defines.h:389
AF_MAT_TRI_DIAG
Matrix is tri diagonal.
Definition: defines.h:312
af::CSpace
af_cspace_t CSpace
Definition: defines.h:390
f32
32-bit floating point values
Definition: defines.h:193
AF_NORM_VECTOR_2
treats the input as a vector and returns euclidean norm
Definition: defines.h:319
AF_COLORMAP_HEAT
Heat map.
Definition: defines.h:335
AF_NORM_VECTOR_1
treats the input as a vector and returns the sum of absolute values
Definition: defines.h:317
version.h
b8
8-bit boolean values
Definition: defines.h:197
AF_INTERP_LOWER
Floor Indexed.
Definition: defines.h:226
afHost
Host pointer.
Definition: defines.h:213
af_dtype
af_dtype
Definition: defines.h:192
af::interpType
af_interp_type interpType
Definition: defines.h:386
af_match_type
af_match_type
Definition: defines.h:272
AF_COLORMAP_RED
Red hue map.
Definition: defines.h:333
AF_ERR_INTERNAL
There was an internal error either in ArrayFire or in a project upstream.
Definition: defines.h:184
af::convMode
af_conv_mode convMode
Definition: defines.h:393
AF_ERR_UNKNOWN
Unknown Error.
Definition: defines.h:189
af::dtype
af_dtype dtype
Definition: defines.h:384
intl
long long intl
Definition: defines.h:59
AF_COLORMAP_COLORS
Colors.
Definition: defines.h:332
AF_ERR_SIZE
The size is incorrect.
Definition: defines.h:105
af::connectivity
af_connectivity connectivity
Definition: defines.h:388
AF_YCC_2020
ITU-R BT.2020 standard.
Definition: defines.h:288