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 {
72 
73  // 100-199 Errors in environment
74 
79 
84 
89 
90  // 200-299 Errors in input parameters
91 
96 
100  AF_ERR_ARG = 202,
101 
105  AF_ERR_SIZE = 203,
106 
110  AF_ERR_TYPE = 204,
111 
116 
121 
122 
123  // 300-399 Errors for missing software features
124 
129 
134 
135 #if AF_API_VERSION >= 32
136  AF_ERR_NONFREE = 303,
140 #endif
141 
142  // 400-499 Errors for missing hardware features
143 
148 
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
176 #endif
177 
178  // 900-999 Errors from upstream libraries and runtimes
179 
185 
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 {
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 {
228 
229 typedef enum {
234 
240 
241 typedef enum {
246 
252 
253 typedef enum {
254 
259 
264 } af_conv_mode;
265 
266 typedef enum {
271 
272 typedef enum {
273  AF_SAD = 0,
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,
296 #if AF_API_VERSION >= 31
298 #endif
299 } af_cspace_t;
300 
301 typedef enum {
309  AF_MAT_SYM = 512,
310  AF_MAT_POSDEF = 1024,
311  AF_MAT_ORTHOG = 2048,
314 } af_mat_prop;
315 
316 typedef enum {
325 
327 } af_norm_type;
328 
329 typedef enum {
337 } af_colormap;
338 
339 #if AF_API_VERSION >= 31
340 typedef enum {
345  AF_FIF_PNG = 13,
346  AF_FIF_PPM = 14,
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,
355 #endif
356 
357 #if AF_API_VERSION >= 32
358 typedef enum {
362 #endif
363 
364 #if AF_API_VERSION >= 32
365 // These enums should be 2^x
366 typedef enum {
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;
391  typedef af_someenum_t SomeEnum; // Purpose of Addition: How to add Function example
398 #if AF_API_VERSION >= 31
400 #endif
401 #if AF_API_VERSION >= 31
403 #endif
404 #if AF_API_VERSION >= 32
406 #endif
407 }
408 
409 #endif
The system or device ran out of memory.
Definition: defines.h:78
af_source source
Definition: defines.h:385
af_ycc_std
Definition: defines.h:285
Matrix is symmetric.
Definition: defines.h:309
returns the max singular value). Currently NOT SUPPORTED
Definition: defines.h:323
Match based on Sum of Squared Differences (SSD)
Definition: defines.h:276
af_someenum_t SomeEnum
Definition: defines.h:391
af_backend
Definition: defines.h:366
af_colormap ColorMap
Definition: defines.h:396
Cubic Interpolation.
Definition: defines.h:225
Matrix is orthogonal.
Definition: defines.h:311
Linear Interpolation.
Definition: defines.h:223
Definition: algorithm.h:14
Definition: defines.h:378
Device pointer.
Definition: defines.h:212
FreeImage Enum for RAW Camera Image File.
Definition: defines.h:353
FreeImage Enum for JPEG Network Graphics File.
Definition: defines.h:344
CPU a.k.a sequential algorithms.
Definition: defines.h:368
The function returned successfully.
Definition: defines.h:71
af_norm_type
Definition: defines.h:316
af_border_type
Definition: defines.h:229
ITU-R BT.709 standard.
Definition: defines.h:287
The type of the input arrays are not compatible.
Definition: defines.h:115
Output of the convolution is signal_len + filter_len - 1.
Definition: defines.h:263
FreeImage Enum for Bitmap File.
Definition: defines.h:341
Blue hue map.
Definition: defines.h:336
Matrix is upper triangular.
Definition: defines.h:306
3-channel YCbCr
Definition: defines.h:297
Matrix diagonal contains unitary values.
Definition: defines.h:308
Output of the convolution is the same size as input.
Definition: defines.h:258
Mood map.
Definition: defines.h:334
32-bit signed integral values
Definition: defines.h:198
Function does not support GFOR / batch mode.
Definition: defines.h:120
af_ycc_std YCCStd
Definition: defines.h:399
Matrix is positive definite.
Definition: defines.h:310
The option is not supported.
Definition: defines.h:128
FreeImage Enum for Windows Icon File.
Definition: defines.h:342
Default backend order: OpenCL -> CUDA -> CPU.
Definition: defines.h:367
CUDA Compute Backend.
Definition: defines.h:369
Match based on Zero mean SAD.
Definition: defines.h:274
64-bit signed integral values
Definition: defines.h:201
16-bit signed integral values
Definition: defines.h:204
Match based on Zero mean SSD.
Definition: defines.h:277
Grayscale.
Definition: defines.h:293
Match based on Zero mean NCC.
Definition: defines.h:280
16-bit unsigned integral values
Definition: defines.h:207
af_backend Backend
Definition: defines.h:405
Default.
Definition: defines.h:302
af_interp_type
Definition: defines.h:221
Match based on Locally scaled SSD.
Definition: defines.h:278
FreeImage Enum for JPEG File.
Definition: defines.h:343
Data needs to be conjugate tansposed.
Definition: defines.h:304
64-bit complex floating point values
Definition: defines.h:195
There was an error when loading the symbols.
Definition: defines.h:168
Match based on Normalized Cross Correlation (NCC)
Definition: defines.h:279
treats the input as a vector and returns the p-norm
Definition: defines.h:320
af_image_format imageFormat
Definition: defines.h:402
af_homography_type
Definition: defines.h:358
af_conv_domain
Definition: defines.h:266
FreeImage Enum for Adobe Photoshop File.
Definition: defines.h:349
af_colormap
Definition: defines.h:329
Computes homography using Least Median of Squares.
Definition: defines.h:360
Data needs to be conjugate.
Definition: defines.h:305
return the max of row sums
Definition: defines.h:322
FreeImage Enum for Portable Pixelmap (ASCII) File.
Definition: defines.h:346
There was an error with the runtime environment.
Definition: defines.h:88
Out of bound values are symmetric over the edge.
Definition: defines.h:238
Spectrum map.
Definition: defines.h:331
3-channel HSV
Definition: defines.h:295
af_connectivity
Definition: defines.h:241
Computes homography using RANSAC.
Definition: defines.h:359
returns Lpq-norm
Definition: defines.h:324
FreeImage Enum for JPEG-2000 File.
Definition: defines.h:352
af_err
Definition: defines.h:67
Match based on Locally scaled SAD.
Definition: defines.h:275
The type is not suppported by this function.
Definition: defines.h:110
af_source
Definition: defines.h:211
Connectivity includes neighbors, North, East, South and West of current pixel.
Definition: defines.h:245
64-bit unsigned integral values
Definition: defines.h:202
af_someenum_t
Definition: defines.h:377
af_conv_mode
Definition: defines.h:253
ITU-R BT.601 (formerly CCIR 601) standard.
Definition: defines.h:286
Out of bound values are 0.
Definition: defines.h:233
Bilinear Interpolation.
Definition: defines.h:224
This device does not support double.
Definition: defines.h:147
64-bit complex floating point values
Definition: defines.h:196
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:153
There was an error when loading the libraries.
Definition: defines.h:161
OpenCL Compute Backend.
Definition: defines.h:370
This build of ArrayFire does not support this feature.
Definition: defines.h:133
There was a mismatch between the input array and the active backend.
Definition: defines.h:175
FreeImage Enum for Tagged Image File Format File.
Definition: defines.h:348
ArrayFire automatically picks the right convolution algorithm.
Definition: defines.h:267
32-bit complex floating point values
Definition: defines.h:194
af_mat_prop matProp
Definition: defines.h:395
af_norm_type normType
Definition: defines.h:397
treats the input as a vector and returns the max of absolute values
Definition: defines.h:318
Matrix is block diagonal.
Definition: defines.h:313
There was an error in the device driver.
Definition: defines.h:83
Connectivity includes 4-connectivity neigbors and also those on Northeast, Northwest, Southeast and Southwest.
Definition: defines.h:250
This build of ArrayFire is not compiled with "nonfree" algorithms.
Definition: defines.h:139
af_conv_domain convDomain
Definition: defines.h:394
The default. Same as AF_NORM_VECTOR_2.
Definition: defines.h:326
8-bit unsigned integral values
Definition: defines.h:200
af_border_type borderType
Definition: defines.h:387
FreeImage Enum for ILM OpenEXR File.
Definition: defines.h:351
Perform convolution in spatial domain.
Definition: defines.h:268
Perform convolution in frequency domain.
Definition: defines.h:269
Match based on Sum of Hamming Distances (SHD)
Definition: defines.h:281
Match based on Sum of Absolute Differences (SAD)
Definition: defines.h:273
Data needs to be transposed.
Definition: defines.h:303
return the max of column sums
Definition: defines.h:321
af_mat_prop trans
Definition: defines.h:392
One of the function arguments is incorrect.
Definition: defines.h:100
Nearest Interpolation.
Definition: defines.h:222
unsigned long long uintl
Definition: defines.h:60
3-channel RGB
Definition: defines.h:294
af_mat_prop
Definition: defines.h:301
The input array is not a valid af_array object.
Definition: defines.h:95
32-bit unsigned integral values
Definition: defines.h:199
FreeImage Enum for High Dynamic Range File.
Definition: defines.h:350
af_cspace_t
Definition: defines.h:292
Default grayscale map.
Definition: defines.h:330
Matrix is lower triangular.
Definition: defines.h:307
FreeImage Enum for Portable Network Graphics File.
Definition: defines.h:345
FreeImage Enum for Portable Pixelmap (Binary) File.
Definition: defines.h:347
void * af_array
Definition: defines.h:219
af_image_format
Definition: defines.h:340
af_match_type matchType
Definition: defines.h:389
Matrix is tri diagonal.
Definition: defines.h:312
af_cspace_t CSpace
Definition: defines.h:390
32-bit floating point values
Definition: defines.h:193
treats the input as a vector and returns euclidean norm
Definition: defines.h:319
Heat map.
Definition: defines.h:335
treats the input as a vector and returns the sum of absolute values
Definition: defines.h:317
8-bit boolean values
Definition: defines.h:197
Floor Indexed.
Definition: defines.h:226
Host pointer.
Definition: defines.h:213
af_dtype
Definition: defines.h:192
af_interp_type interpType
Definition: defines.h:386
af_match_type
Definition: defines.h:272
Red hue map.
Definition: defines.h:333
There was an internal error either in ArrayFire or in a project upstream.
Definition: defines.h:184
af_conv_mode convMode
Definition: defines.h:393
Unknown Error.
Definition: defines.h:189
af_dtype dtype
Definition: defines.h:384
long long intl
Definition: defines.h:59
Colors.
Definition: defines.h:332
The size is incorrect.
Definition: defines.h:105
af_connectivity connectivity
Definition: defines.h:388
ITU-R BT.2020 standard.
Definition: defines.h:288