defines.h

Go to the documentation of this file.

/*******************************************************
 * Copyright (c) 2014, ArrayFire
 * All rights reserved.
 *
 * This file is distributed under 3-clause BSD license.
 * The complete license agreement can be obtained at:
 * http://arrayfire.com/licenses/BSD-3-Clause
 ********************************************************/

#pragma once

#ifndef __CUDACC_RTC__
#include <af/compilers.h>
#endif

#if defined(_WIN32) || defined(_MSC_VER)
    // http://msdn.microsoft.com/en-us/library/b0084kay(v=VS.80).aspx
    // http://msdn.microsoft.com/en-us/library/3y1sfaz2%28v=VS.80%29.aspx
    #ifdef AFDLL // libaf
        #define AFAPI  __declspec(dllexport)
    #else
        #define AFAPI  __declspec(dllimport)
    #endif

    // bool
    #ifndef __cplusplus
        #define bool unsigned char
        #define false 0
        #define true  1
    #endif
    #define __PRETTY_FUNCTION__ __FUNCSIG__
    #define SIZE_T_FRMT_SPECIFIER "%Iu"
    #define AF_DEPRECATED(msg) __declspec(deprecated( msg ))
    #if _MSC_VER >= 1800
        #define AF_HAS_VARIADIC_TEMPLATES
    #endif
#else
    #define AFAPI   __attribute__((visibility("default")))
    #include <stdbool.h>
    #define SIZE_T_FRMT_SPECIFIER "%zu"
#if __GNUC__ >= 4 && __GNUC_MINOR > 4
    #define AF_DEPRECATED(msg) __attribute__((deprecated( msg )))
#else
    #define AF_DEPRECATED(msg) __attribute__((deprecated))
#endif
#endif

// Known 64-bit x86 and ARM architectures use long long
#if defined(__x86_64__) || defined(_M_X64) || defined(_WIN64) || defined(__aarch64__) || defined(__LP64__)   // 64-bit Architectures
    typedef long long   dim_t;
// Known 32-bit x86 and ARM architectures use int
#elif defined(__i386__) || defined(_M_IX86) || defined(__arm__) || defined(_M_ARM)     // 32-bit x86 Architecture
    typedef int         dim_t;
// All other platforms use long long
#else
    typedef long long   dim_t;
#endif

#include <stdlib.h>

#ifndef AFDLL  // prevents the use of these types internally
typedef AF_DEPRECATED("intl is deprecated. Use long long instead.") long long intl;
typedef AF_DEPRECATED("uintl is deprecated. Use unsigned long long instead.") unsigned long long uintl;
#endif

#include <af/version.h>
#ifndef AF_API_VERSION
#define AF_API_VERSION AF_API_VERSION_CURRENT
#endif

typedef enum {
    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;

typedef enum {
    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;

typedef enum {
    afDevice,   
    afHost     
} af_source;

#define AF_MAX_DIMS 4

// A handle for an internal array object
typedef void * af_array;

typedef enum {
    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;

typedef enum {
    AF_PAD_ZERO = 0,

    AF_PAD_SYM,

    AF_PAD_CLAMP_TO_EDGE,

    AF_PAD_PERIODIC
} af_border_type;

typedef enum {
    AF_CONNECTIVITY_4 = 4,

    AF_CONNECTIVITY_8 = 8
} af_connectivity;

typedef enum {

    AF_CONV_DEFAULT,

    AF_CONV_EXPAND
} af_conv_mode;

typedef enum {
    AF_CONV_AUTO,    
    AF_CONV_SPATIAL, 
    AF_CONV_FREQ     
} af_conv_domain;

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

#if AF_API_VERSION >= 31
typedef enum {
    AF_YCC_601 = 601,  
    AF_YCC_709 = 709,  
    AF_YCC_2020 = 2020 
} af_ycc_std;
#endif

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

typedef enum {
    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;

typedef enum {
    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;

#if AF_API_VERSION >= 31
typedef enum {
    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;
#endif

#if AF_API_VERSION >=34
typedef enum {
    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;
#endif

#if AF_API_VERSION >= 32
typedef enum {
    AF_HOMOGRAPHY_RANSAC = 0,   
    AF_HOMOGRAPHY_LMEDS  = 1    
} af_homography_type;
#endif

#if AF_API_VERSION >= 32
// These enums should be 2^x
typedef enum {
    AF_BACKEND_DEFAULT = 0,  
    AF_BACKEND_CPU     = 1,  
    AF_BACKEND_CUDA    = 2,  
    AF_BACKEND_OPENCL  = 4,  
    AF_BACKEND_ONEAPI  = 8   
} af_backend;
#endif

// Below enum is purely added for example purposes
// it doesn't and shoudn't be used anywhere in the
// code. No Guarantee's provided if it is used.
typedef enum {
    AF_ID = 0
} af_someenum_t;

#if AF_API_VERSION >=34
typedef enum {
    AF_BINARY_ADD  = 0,
    AF_BINARY_MUL  = 1,
    AF_BINARY_MIN  = 2,
    AF_BINARY_MAX  = 3
} af_binary_op;
#endif

#if AF_API_VERSION >=34
typedef enum {
    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;
#endif

// FORGE / Graphics Related Enums
// These enums have values corresponsding to Forge enums in forge defines.h
typedef enum {
    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;

#if AF_API_VERSION >= 32
typedef enum {
    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;
#endif

#if AF_API_VERSION >= 35
typedef enum {
    AF_CANNY_THRESHOLD_MANUAL    = 0, 
    AF_CANNY_THRESHOLD_AUTO_OTSU = 1  
} af_canny_threshold;
#endif

#if AF_API_VERSION >= 34
typedef enum {
    AF_STORAGE_DENSE     = 0,   
    AF_STORAGE_CSR       = 1,   
    AF_STORAGE_CSC       = 2,   
    AF_STORAGE_COO       = 3    
} af_storage;
#endif

#if AF_API_VERSION >= 36
typedef enum {
    AF_FLUX_QUADRATIC   = 1,    
    AF_FLUX_EXPONENTIAL = 2,    
    AF_FLUX_DEFAULT     = 0     
} af_flux_function;

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

typedef enum {
    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;
#endif

#if AF_API_VERSION >= 37
typedef enum {
    AF_VARIANCE_DEFAULT    = 0, 
    AF_VARIANCE_SAMPLE     = 1, 
    AF_VARIANCE_POPULATION = 2  
} af_var_bias;

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

typedef enum {
    AF_INVERSE_DECONV_TIKHONOV       = 1,        
    AF_INVERSE_DECONV_DEFAULT        = 0         
} af_inverse_deconv_algo;

#endif

#if AF_API_VERSION >= 37
typedef enum {
    AF_CONV_GRADIENT_DEFAULT = 0,
    AF_CONV_GRADIENT_FILTER  = 1,
    AF_CONV_GRADIENT_DATA    = 2,
    AF_CONV_GRADIENT_BIAS    = 3
} af_conv_gradient_type;
#endif

#ifdef __cplusplus
namespace af
{
    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; // Purpose of Addition: How to add Function example
    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;
#if AF_API_VERSION >= 31
    typedef af_ycc_std YCCStd;
#endif
#if AF_API_VERSION >= 31
    typedef af_image_format imageFormat;
#endif
#if AF_API_VERSION >= 32
    typedef af_backend Backend;
#endif
#if AF_API_VERSION >= 32
    typedef af_marker_type markerType;
#endif
#if AF_API_VERSION >= 34
    typedef af_moment_type momentType;
#endif
#if AF_API_VERSION >= 34
    typedef af_storage storage;
#endif
#if AF_API_VERSION >= 34
    typedef af_binary_op binaryOp;
#endif
#if AF_API_VERSION >= 34
    typedef af_random_engine_type randomEngineType;
#endif
#if AF_API_VERSION >= 35
    typedef af_canny_threshold cannyThreshold;
#endif
#if AF_API_VERSION >= 36
    typedef af_flux_function fluxFunction;
    typedef af_diffusion_eq diffusionEq;
    typedef af_topk_function topkFunction;
#endif
#if AF_API_VERSION >= 37
    typedef af_var_bias varBias;
    typedef af_iterative_deconv_algo iterativeDeconvAlgo;
    typedef af_inverse_deconv_algo inverseDeconvAlgo;
    typedef af_conv_gradient_type convGradientType;
#endif
}

#endif