// This file is part of Eigen, a lightweight C++ template library // for linear algebra. // // Copyright (C) 2008-2015 Gael Guennebaud <[email protected]> // Copyright (C) 2006-2008 Benoit Jacob <[email protected]> // // This Source Code Form is subject to the terms of the Mozilla // Public License v. 2.0. If a copy of the MPL was not distributed // with this file, You can obtain one at http://mozilla.org/MPL/2.0/. #ifndef EIGEN_MACROS_H #define EIGEN_MACROS_H // IWYU pragma: private #include "../InternalHeaderCheck.h" //------------------------------------------------------------------------------------------ // Eigen version and basic defaults //------------------------------------------------------------------------------------------ #define EIGEN_WORLD_VERSION … #define EIGEN_MAJOR_VERSION … #define EIGEN_MINOR_VERSION … #define EIGEN_VERSION_AT_LEAST(x, y, z) … #ifdef EIGEN_DEFAULT_TO_ROW_MAJOR #define EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION … #else #define EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION … #endif #ifndef EIGEN_DEFAULT_DENSE_INDEX_TYPE #define EIGEN_DEFAULT_DENSE_INDEX_TYPE … #endif // Upperbound on the C++ version to use. // Expected values are 03, 11, 14, 17, etc. // By default, let's use an arbitrarily large C++ version. #ifndef EIGEN_MAX_CPP_VER #define EIGEN_MAX_CPP_VER … #endif /** Allows to disable some optimizations which might affect the accuracy of the result. * Such optimization are enabled by default, and set EIGEN_FAST_MATH to 0 to disable them. * They currently include: * - single precision ArrayBase::sin() and ArrayBase::cos() for SSE and AVX vectorization. */ #ifndef EIGEN_FAST_MATH #define EIGEN_FAST_MATH … #endif #ifndef EIGEN_STACK_ALLOCATION_LIMIT // 131072 == 128 KB #define EIGEN_STACK_ALLOCATION_LIMIT … #endif //------------------------------------------------------------------------------------------ // Compiler identification, EIGEN_COMP_* //------------------------------------------------------------------------------------------ /// \internal EIGEN_COMP_GNUC set to version (e.g., 951 for GCC 9.5.1) for all compilers compatible with GCC #ifdef __GNUC__ #define EIGEN_COMP_GNUC … #else #define EIGEN_COMP_GNUC … #endif /// \internal EIGEN_COMP_CLANG set to version (e.g., 372 for clang 3.7.2) if the compiler is clang #if defined(__clang__) #define EIGEN_COMP_CLANG … #else #define EIGEN_COMP_CLANG … #endif /// \internal EIGEN_COMP_CLANGAPPLE set to the version number (e.g. 9000000 for AppleClang 9.0) if the compiler is /// AppleClang #if defined(__clang__) && defined(__apple_build_version__) #define EIGEN_COMP_CLANGAPPLE … #else #define EIGEN_COMP_CLANGAPPLE … #endif /// \internal EIGEN_COMP_CASTXML set to 1 if being preprocessed by CastXML #if defined(__castxml__) #define EIGEN_COMP_CASTXML … #else #define EIGEN_COMP_CASTXML … #endif /// \internal EIGEN_COMP_LLVM set to 1 if the compiler backend is llvm #if defined(__llvm__) #define EIGEN_COMP_LLVM … #else #define EIGEN_COMP_LLVM … #endif /// \internal EIGEN_COMP_ICC set to __INTEL_COMPILER if the compiler is Intel icc compiler, 0 otherwise #if defined(__INTEL_COMPILER) #define EIGEN_COMP_ICC … #else #define EIGEN_COMP_ICC … #endif /// \internal EIGEN_COMP_CLANGICC set to __INTEL_CLANG_COMPILER if the compiler is Intel icx compiler, 0 otherwise #if defined(__INTEL_CLANG_COMPILER) #define EIGEN_COMP_CLANGICC … #else #define EIGEN_COMP_CLANGICC … #endif /// \internal EIGEN_COMP_MINGW set to 1 if the compiler is mingw #if defined(__MINGW32__) #define EIGEN_COMP_MINGW … #else #define EIGEN_COMP_MINGW … #endif /// \internal EIGEN_COMP_SUNCC set to 1 if the compiler is Solaris Studio #if defined(__SUNPRO_CC) #define EIGEN_COMP_SUNCC … #else #define EIGEN_COMP_SUNCC … #endif /// \internal EIGEN_COMP_MSVC set to _MSC_VER if the compiler is Microsoft Visual C++, 0 otherwise. #if defined(_MSC_VER) #define EIGEN_COMP_MSVC … #else #define EIGEN_COMP_MSVC … #endif #if defined(__NVCC__) #if defined(__CUDACC_VER_MAJOR__) && (__CUDACC_VER_MAJOR__ >= 9) #define EIGEN_COMP_NVCC … #elif defined(__CUDACC_VER__) #define EIGEN_COMP_NVCC … #else #error "NVCC did not define compiler version." #endif #else #define EIGEN_COMP_NVCC … #endif // For the record, here is a table summarizing the possible values for EIGEN_COMP_MSVC: // name ver MSC_VER // 2015 14 1900 // "15" 15 1900 // 2017-14.1 15.0 1910 // 2017-14.11 15.3 1911 // 2017-14.12 15.5 1912 // 2017-14.13 15.6 1913 // 2017-14.14 15.7 1914 // 2017 15.8 1915 // 2017 15.9 1916 // 2019 RTW 16.0 1920 /// \internal EIGEN_COMP_MSVC_LANG set to _MSVC_LANG if the compiler is Microsoft Visual C++, 0 otherwise. #if defined(_MSVC_LANG) #define EIGEN_COMP_MSVC_LANG … #else #define EIGEN_COMP_MSVC_LANG … #endif // For the record, here is a table summarizing the possible values for EIGEN_COMP_MSVC_LANG: // MSVC option Standard MSVC_LANG // /std:c++14 (default as of VS 2019) C++14 201402L // /std:c++17 C++17 201703L // /std:c++latest >C++17 >201703L /// \internal EIGEN_COMP_MSVC_STRICT set to 1 if the compiler is really Microsoft Visual C++ and not ,e.g., ICC or /// clang-cl #if EIGEN_COMP_MSVC && !(EIGEN_COMP_ICC || EIGEN_COMP_LLVM || EIGEN_COMP_CLANG) #define EIGEN_COMP_MSVC_STRICT … #else #define EIGEN_COMP_MSVC_STRICT … #endif /// \internal EIGEN_COMP_IBM set to xlc version if the compiler is IBM XL C++ // XLC version // 3.1 0x0301 // 4.5 0x0405 // 5.0 0x0500 // 12.1 0x0C01 #if defined(__IBMCPP__) || defined(__xlc__) || defined(__ibmxl__) #define EIGEN_COMP_IBM … #else #define EIGEN_COMP_IBM … #endif /// \internal EIGEN_COMP_PGI set to PGI version if the compiler is Portland Group Compiler #if defined(__PGI) #define EIGEN_COMP_PGI … #else #define EIGEN_COMP_PGI … #endif /// \internal EIGEN_COMP_ARM set to 1 if the compiler is ARM Compiler #if defined(__CC_ARM) || defined(__ARMCC_VERSION) #define EIGEN_COMP_ARM … #else #define EIGEN_COMP_ARM … #endif /// \internal EIGEN_COMP_EMSCRIPTEN set to 1 if the compiler is Emscripten Compiler #if defined(__EMSCRIPTEN__) #define EIGEN_COMP_EMSCRIPTEN … #else #define EIGEN_COMP_EMSCRIPTEN … #endif /// \internal EIGEN_COMP_FCC set to FCC version if the compiler is Fujitsu Compiler (traditional mode) /// \note The Fujitsu C/C++ compiler uses the traditional mode based /// on EDG g++ 6.1 by default or if envoked with the -Nnoclang flag #if defined(__FUJITSU) #define EIGEN_COMP_FCC … #else #define EIGEN_COMP_FCC … #endif /// \internal EIGEN_COMP_CLANGFCC set to FCC version if the compiler is Fujitsu Compiler (Clang mode) /// \note The Fujitsu C/C++ compiler uses the non-traditional mode /// based on Clang 7.1.0 if envoked with the -Nclang flag #if defined(__CLANG_FUJITSU) #define EIGEN_COMP_CLANGFCC … #else #define EIGEN_COMP_CLANGFCC … #endif /// \internal EIGEN_COMP_CPE set to CPE version if the compiler is HPE Cray Compiler (GCC based) /// \note This is the SVE-enabled C/C++ compiler from the HPE Cray /// Programming Environment (CPE) based on Cray GCC 8.1 #if defined(_CRAYC) && !defined(__clang__) #define EIGEN_COMP_CPE … #else #define EIGEN_COMP_CPE … #endif /// \internal EIGEN_COMP_CLANGCPE set to CPE version if the compiler is HPE Cray Compiler (Clang based) /// \note This is the C/C++ compiler from the HPE Cray Programming /// Environment (CPE) based on Cray Clang 11.0 without SVE-support #if defined(_CRAYC) && defined(__clang__) #define EIGEN_COMP_CLANGCPE … #else #define EIGEN_COMP_CLANGCPE … #endif /// \internal EIGEN_COMP_LCC set to 1 if the compiler is MCST-LCC (MCST eLbrus Compiler Collection) #if defined(__LCC__) && defined(__MCST__) #define EIGEN_COMP_LCC … #else #define EIGEN_COMP_LCC … #endif /// \internal EIGEN_COMP_GNUC_STRICT set to 1 if the compiler is really GCC and not a compatible compiler (e.g., ICC, /// clang, mingw, etc.) #if EIGEN_COMP_GNUC && \ !(EIGEN_COMP_CLANG || EIGEN_COMP_ICC || EIGEN_COMP_CLANGICC || EIGEN_COMP_MINGW || EIGEN_COMP_PGI || \ EIGEN_COMP_IBM || EIGEN_COMP_ARM || EIGEN_COMP_EMSCRIPTEN || EIGEN_COMP_FCC || EIGEN_COMP_CLANGFCC || \ EIGEN_COMP_CPE || EIGEN_COMP_CLANGCPE || EIGEN_COMP_LCC) #define EIGEN_COMP_GNUC_STRICT … #else #define EIGEN_COMP_GNUC_STRICT … #endif // GCC, and compilers that pretend to be it, have different version schemes, so this only makes sense to use with the // real GCC. #if EIGEN_COMP_GNUC_STRICT #define EIGEN_GNUC_STRICT_AT_LEAST … #define EIGEN_GNUC_STRICT_LESS_THAN … #else #define EIGEN_GNUC_STRICT_AT_LEAST(x, y, z) … #define EIGEN_GNUC_STRICT_LESS_THAN(x, y, z) … #endif /// \internal EIGEN_COMP_CLANG_STRICT set to 1 if the compiler is really Clang and not a compatible compiler (e.g., /// AppleClang, etc.) #if EIGEN_COMP_CLANG && !(EIGEN_COMP_CLANGAPPLE || EIGEN_COMP_CLANGICC || EIGEN_COMP_CLANGFCC || EIGEN_COMP_CLANGCPE) #define EIGEN_COMP_CLANG_STRICT … #else #define EIGEN_COMP_CLANG_STRICT … #endif // Clang, and compilers forked from it, have different version schemes, so this only makes sense to use with the real // Clang. #if EIGEN_COMP_CLANG_STRICT #define EIGEN_CLANG_STRICT_AT_LEAST(x, y, z) … #define EIGEN_CLANG_STRICT_LESS_THAN(x, y, z) … #else #define EIGEN_CLANG_STRICT_AT_LEAST … #define EIGEN_CLANG_STRICT_LESS_THAN … #endif //------------------------------------------------------------------------------------------ // Architecture identification, EIGEN_ARCH_* //------------------------------------------------------------------------------------------ #if defined(__x86_64__) || (defined(_M_X64) && !defined(_M_ARM64EC)) || defined(__amd64) #define EIGEN_ARCH_x86_64 … #else #define EIGEN_ARCH_x86_64 … #endif #if defined(__i386__) || defined(_M_IX86) || defined(_X86_) || defined(__i386) #define EIGEN_ARCH_i386 … #else #define EIGEN_ARCH_i386 … #endif #if EIGEN_ARCH_x86_64 || EIGEN_ARCH_i386 #define EIGEN_ARCH_i386_OR_x86_64 … #else #define EIGEN_ARCH_i386_OR_x86_64 … #endif /// \internal EIGEN_ARCH_ARM set to 1 if the architecture is ARM #if defined(__arm__) #define EIGEN_ARCH_ARM … #else #define EIGEN_ARCH_ARM … #endif /// \internal EIGEN_ARCH_ARM64 set to 1 if the architecture is ARM64 #if defined(__aarch64__) || defined(_M_ARM64) || defined(_M_ARM64EC) #define EIGEN_ARCH_ARM64 … #else #define EIGEN_ARCH_ARM64 … #endif /// \internal EIGEN_ARCH_ARM_OR_ARM64 set to 1 if the architecture is ARM or ARM64 #if EIGEN_ARCH_ARM || EIGEN_ARCH_ARM64 #define EIGEN_ARCH_ARM_OR_ARM64 … #else #define EIGEN_ARCH_ARM_OR_ARM64 … #endif /// \internal EIGEN_ARCH_ARMV8 set to 1 if the architecture is armv8 or greater. #if EIGEN_ARCH_ARM_OR_ARM64 && defined(__ARM_ARCH) && __ARM_ARCH >= 8 #define EIGEN_ARCH_ARMV8 … #else #define EIGEN_ARCH_ARMV8 … #endif /// \internal EIGEN_HAS_ARM64_FP16 set to 1 if the architecture provides an IEEE /// compliant Arm fp16 type #if EIGEN_ARCH_ARM_OR_ARM64 #ifndef EIGEN_HAS_ARM64_FP16 #if defined(__ARM_FP16_FORMAT_IEEE) #define EIGEN_HAS_ARM64_FP16 … #else #define EIGEN_HAS_ARM64_FP16 … #endif #endif #endif /// \internal EIGEN_ARCH_MIPS set to 1 if the architecture is MIPS #if defined(__mips__) || defined(__mips) #define EIGEN_ARCH_MIPS … #else #define EIGEN_ARCH_MIPS … #endif /// \internal EIGEN_ARCH_SPARC set to 1 if the architecture is SPARC #if defined(__sparc__) || defined(__sparc) #define EIGEN_ARCH_SPARC … #else #define EIGEN_ARCH_SPARC … #endif /// \internal EIGEN_ARCH_IA64 set to 1 if the architecture is Intel Itanium #if defined(__ia64__) #define EIGEN_ARCH_IA64 … #else #define EIGEN_ARCH_IA64 … #endif /// \internal EIGEN_ARCH_PPC set to 1 if the architecture is PowerPC #if defined(__powerpc__) || defined(__ppc__) || defined(_M_PPC) || defined(__POWERPC__) #define EIGEN_ARCH_PPC … #else #define EIGEN_ARCH_PPC … #endif //------------------------------------------------------------------------------------------ // Operating system identification, EIGEN_OS_* //------------------------------------------------------------------------------------------ /// \internal EIGEN_OS_UNIX set to 1 if the OS is a unix variant #if defined(__unix__) || defined(__unix) #define EIGEN_OS_UNIX … #else #define EIGEN_OS_UNIX … #endif /// \internal EIGEN_OS_LINUX set to 1 if the OS is based on Linux kernel #if defined(__linux__) #define EIGEN_OS_LINUX … #else #define EIGEN_OS_LINUX … #endif /// \internal EIGEN_OS_ANDROID set to 1 if the OS is Android // note: ANDROID is defined when using ndk_build, __ANDROID__ is defined when using a standalone toolchain. #if defined(__ANDROID__) || defined(ANDROID) #define EIGEN_OS_ANDROID … #else #define EIGEN_OS_ANDROID … #endif /// \internal EIGEN_OS_GNULINUX set to 1 if the OS is GNU Linux and not Linux-based OS (e.g., not android) #if defined(__gnu_linux__) && !(EIGEN_OS_ANDROID) #define EIGEN_OS_GNULINUX … #else #define EIGEN_OS_GNULINUX … #endif /// \internal EIGEN_OS_BSD set to 1 if the OS is a BSD variant #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__bsdi__) || defined(__DragonFly__) #define EIGEN_OS_BSD … #else #define EIGEN_OS_BSD … #endif /// \internal EIGEN_OS_MAC set to 1 if the OS is MacOS #if defined(__APPLE__) #define EIGEN_OS_MAC … #else #define EIGEN_OS_MAC … #endif /// \internal EIGEN_OS_QNX set to 1 if the OS is QNX #if defined(__QNX__) #define EIGEN_OS_QNX … #else #define EIGEN_OS_QNX … #endif /// \internal EIGEN_OS_WIN set to 1 if the OS is Windows based #if defined(_WIN32) #define EIGEN_OS_WIN … #else #define EIGEN_OS_WIN … #endif /// \internal EIGEN_OS_WIN64 set to 1 if the OS is Windows 64bits #if defined(_WIN64) #define EIGEN_OS_WIN64 … #else #define EIGEN_OS_WIN64 … #endif /// \internal EIGEN_OS_WINCE set to 1 if the OS is Windows CE #if defined(_WIN32_WCE) #define EIGEN_OS_WINCE … #else #define EIGEN_OS_WINCE … #endif /// \internal EIGEN_OS_CYGWIN set to 1 if the OS is Windows/Cygwin #if defined(__CYGWIN__) #define EIGEN_OS_CYGWIN … #else #define EIGEN_OS_CYGWIN … #endif /// \internal EIGEN_OS_WIN_STRICT set to 1 if the OS is really Windows and not some variants #if EIGEN_OS_WIN && !(EIGEN_OS_WINCE || EIGEN_OS_CYGWIN) #define EIGEN_OS_WIN_STRICT … #else #define EIGEN_OS_WIN_STRICT … #endif /// \internal EIGEN_OS_SUN set to __SUNPRO_C if the OS is SUN // compiler solaris __SUNPRO_C // version studio // 5.7 10 0x570 // 5.8 11 0x580 // 5.9 12 0x590 // 5.10 12.1 0x5100 // 5.11 12.2 0x5110 // 5.12 12.3 0x5120 #if (defined(sun) || defined(__sun)) && !(defined(__SVR4) || defined(__svr4__)) #define EIGEN_OS_SUN … #else #define EIGEN_OS_SUN … #endif /// \internal EIGEN_OS_SOLARIS set to 1 if the OS is Solaris #if (defined(sun) || defined(__sun)) && (defined(__SVR4) || defined(__svr4__)) #define EIGEN_OS_SOLARIS … #else #define EIGEN_OS_SOLARIS … #endif //------------------------------------------------------------------------------------------ // Detect GPU compilers and architectures //------------------------------------------------------------------------------------------ // NVCC is not supported as the target platform for HIPCC // Note that this also makes EIGEN_CUDACC and EIGEN_HIPCC mutually exclusive #if defined(__NVCC__) && defined(__HIPCC__) #error "NVCC as the target platform for HIPCC is currently not supported." #endif #if defined(__CUDACC__) && !defined(EIGEN_NO_CUDA) && !defined(__SYCL_DEVICE_ONLY__) // Means the compiler is either nvcc or clang with CUDA enabled #define EIGEN_CUDACC … #endif #if defined(__CUDA_ARCH__) && !defined(EIGEN_NO_CUDA) && !defined(__SYCL_DEVICE_ONLY__) // Means we are generating code for the device #define EIGEN_CUDA_ARCH … #endif #if defined(EIGEN_CUDACC) #include <cuda.h> #define EIGEN_CUDA_SDK_VER … #else #define EIGEN_CUDA_SDK_VER … #endif #if defined(__HIPCC__) && !defined(EIGEN_NO_HIP) && !defined(__SYCL_DEVICE_ONLY__) // Means the compiler is HIPCC (analogous to EIGEN_CUDACC, but for HIP) #define EIGEN_HIPCC … // We need to include hip_runtime.h here because it pulls in // ++ hip_common.h which contains the define for __HIP_DEVICE_COMPILE__ // ++ host_defines.h which contains the defines for the __host__ and __device__ macros #include <hip/hip_runtime.h> #if defined(__HIP_DEVICE_COMPILE__) && !defined(__SYCL_DEVICE_ONLY__) // analogous to EIGEN_CUDA_ARCH, but for HIP #define EIGEN_HIP_DEVICE_COMPILE … #endif // For HIP (ROCm 3.5 and higher), we need to explicitly set the launch_bounds attribute // value to 1024. The compiler assigns a default value of 256 when the attribute is not // specified. This results in failures on the HIP platform, for cases when a GPU kernel // without an explicit launch_bounds attribute is called with a threads_per_block value // greater than 256. // // This is a regression in functioanlity and is expected to be fixed within the next // couple of ROCm releases (compiler will go back to using 1024 value as the default) // // In the meantime, we will use a "only enabled for HIP" macro to set the launch_bounds // attribute. #define EIGEN_HIP_LAUNCH_BOUNDS_1024 … #endif #if !defined(EIGEN_HIP_LAUNCH_BOUNDS_1024) #define EIGEN_HIP_LAUNCH_BOUNDS_1024 #endif // !defined(EIGEN_HIP_LAUNCH_BOUNDS_1024) // Unify CUDA/HIPCC #if defined(EIGEN_CUDACC) || defined(EIGEN_HIPCC) // // If either EIGEN_CUDACC or EIGEN_HIPCC is defined, then define EIGEN_GPUCC // #define EIGEN_GPUCC // // EIGEN_HIPCC implies the HIP compiler and is used to tweak Eigen code for use in HIP kernels // EIGEN_CUDACC implies the CUDA compiler and is used to tweak Eigen code for use in CUDA kernels // // In most cases the same tweaks are required to the Eigen code to enable in both the HIP and CUDA kernels. // For those cases, the corresponding code should be guarded with // #if defined(EIGEN_GPUCC) // instead of // #if defined(EIGEN_CUDACC) || defined(EIGEN_HIPCC) // // For cases where the tweak is specific to HIP, the code should be guarded with // #if defined(EIGEN_HIPCC) // // For cases where the tweak is specific to CUDA, the code should be guarded with // #if defined(EIGEN_CUDACC) // #endif #if defined(EIGEN_CUDA_ARCH) || defined(EIGEN_HIP_DEVICE_COMPILE) // // If either EIGEN_CUDA_ARCH or EIGEN_HIP_DEVICE_COMPILE is defined, then define EIGEN_GPU_COMPILE_PHASE // #define EIGEN_GPU_COMPILE_PHASE // // GPU compilers (HIPCC, NVCC) typically do two passes over the source code, // + one to compile the source for the "host" (ie CPU) // + another to compile the source for the "device" (ie. GPU) // // Code that needs to enabled only during the either the "host" or "device" compilation phase // needs to be guarded with a macro that indicates the current compilation phase // // EIGEN_HIP_DEVICE_COMPILE implies the device compilation phase in HIP // EIGEN_CUDA_ARCH implies the device compilation phase in CUDA // // In most cases, the "host" / "device" specific code is the same for both HIP and CUDA // For those cases, the code should be guarded with // #if defined(EIGEN_GPU_COMPILE_PHASE) // instead of // #if defined(EIGEN_CUDA_ARCH) || defined(EIGEN_HIP_DEVICE_COMPILE) // // For cases where the tweak is specific to HIP, the code should be guarded with // #if defined(EIGEN_HIP_DEVICE_COMPILE) // // For cases where the tweak is specific to CUDA, the code should be guarded with // #if defined(EIGEN_CUDA_ARCH) // #endif /// \internal EIGEN_HAS_ARM64_FP16_VECTOR_ARITHMETIC set to 1 if the architecture /// supports Neon vector intrinsics for fp16. #if EIGEN_ARCH_ARM_OR_ARM64 #ifndef EIGEN_HAS_ARM64_FP16_VECTOR_ARITHMETIC // Clang only supports FP16 on aarch64, and not all intrinsics are available // on A32 anyways even in GCC (e.g. vdiv_f16, vsqrt_f16). #if EIGEN_ARCH_ARM64 && defined(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC) && !defined(EIGEN_GPU_COMPILE_PHASE) #define EIGEN_HAS_ARM64_FP16_VECTOR_ARITHMETIC … #else #define EIGEN_HAS_ARM64_FP16_VECTOR_ARITHMETIC … #endif #endif #endif /// \internal EIGEN_HAS_ARM64_FP16_SCALAR_ARITHMETIC set to 1 if the architecture /// supports Neon scalar intrinsics for fp16. #if EIGEN_ARCH_ARM_OR_ARM64 #ifndef EIGEN_HAS_ARM64_FP16_SCALAR_ARITHMETIC // Clang only supports FP16 on aarch64, and not all intrinsics are available // on A32 anyways, even in GCC (e.g. vceqh_f16). #if EIGEN_ARCH_ARM64 && defined(__ARM_FEATURE_FP16_SCALAR_ARITHMETIC) && !defined(EIGEN_GPU_COMPILE_PHASE) #define EIGEN_HAS_ARM64_FP16_SCALAR_ARITHMETIC … #endif #endif #endif #if defined(EIGEN_USE_SYCL) && defined(__SYCL_DEVICE_ONLY__) // EIGEN_USE_SYCL is a user-defined macro while __SYCL_DEVICE_ONLY__ is a compiler-defined macro. // In most cases we want to check if both macros are defined which can be done using the define below. #define SYCL_DEVICE_ONLY #endif //------------------------------------------------------------------------------------------ // Detect Compiler/Architecture/OS specific features //------------------------------------------------------------------------------------------ // Cross compiler wrapper around LLVM's __has_builtin #ifdef __has_builtin #define EIGEN_HAS_BUILTIN(x) … #else #define EIGEN_HAS_BUILTIN … #endif // A Clang feature extension to determine compiler features. // We use it to determine 'cxx_rvalue_references' #ifndef __has_feature #define __has_feature … #endif // The macro EIGEN_CPLUSPLUS is a replacement for __cplusplus/_MSVC_LANG that // works for both platforms, indicating the C++ standard version number. // // With MSVC, without defining /Zc:__cplusplus, the __cplusplus macro will // report 199711L regardless of the language standard specified via /std. // We need to rely on _MSVC_LANG instead, which is only available after // VS2015.3. #if EIGEN_COMP_MSVC_LANG > 0 #define EIGEN_CPLUSPLUS … #elif EIGEN_COMP_MSVC >= 1900 #define EIGEN_CPLUSPLUS … #elif defined(__cplusplus) #define EIGEN_CPLUSPLUS … #else #define EIGEN_CPLUSPLUS … #endif // The macro EIGEN_COMP_CXXVER defines the c++ version expected by the compiler. // For instance, if compiling with gcc and -std=c++17, then EIGEN_COMP_CXXVER // is defined to 17. #if EIGEN_CPLUSPLUS >= 202002L #define EIGEN_COMP_CXXVER … #elif EIGEN_CPLUSPLUS >= 201703L #define EIGEN_COMP_CXXVER … #elif EIGEN_CPLUSPLUS >= 201402L #define EIGEN_COMP_CXXVER … #elif EIGEN_CPLUSPLUS >= 201103L #define EIGEN_COMP_CXXVER … #else #define EIGEN_COMP_CXXVER … #endif // The macros EIGEN_HAS_CXX?? defines a rough estimate of available c++ features // but in practice we should not rely on them but rather on the availability of // individual features as defined later. // This is why there is no EIGEN_HAS_CXX17. #if EIGEN_MAX_CPP_VER < 14 || EIGEN_COMP_CXXVER < 14 || (EIGEN_COMP_MSVC && EIGEN_COMP_MSVC < 1900) || \ (EIGEN_COMP_ICC && EIGEN_COMP_ICC < 1500) || (EIGEN_COMP_NVCC && EIGEN_COMP_NVCC < 80000) || \ (EIGEN_COMP_CLANG_STRICT && EIGEN_COMP_CLANG < 390) || \ (EIGEN_COMP_CLANGAPPLE && EIGEN_COMP_CLANGAPPLE < 9000000) || (EIGEN_COMP_GNUC_STRICT && EIGEN_COMP_GNUC < 510) #error Eigen requires at least c++14 support. #endif // Does the compiler support C99? // Need to include <cmath> to make sure _GLIBCXX_USE_C99 gets defined #include <cmath> #ifndef EIGEN_HAS_C99_MATH #if ((defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901)) || \ (defined(__GNUC__) && defined(_GLIBCXX_USE_C99)) || (defined(_LIBCPP_VERSION) && !defined(_MSC_VER)) || \ (EIGEN_COMP_MSVC) || defined(SYCL_DEVICE_ONLY)) #define EIGEN_HAS_C99_MATH … #else #define EIGEN_HAS_C99_MATH … #endif #endif // Does the compiler support std::hash? #ifndef EIGEN_HAS_STD_HASH // The std::hash struct is defined in C++11 but is not labelled as a __device__ // function and is not constexpr, so cannot be used on device. #if !defined(EIGEN_GPU_COMPILE_PHASE) #define EIGEN_HAS_STD_HASH … #else #define EIGEN_HAS_STD_HASH … #endif #endif // EIGEN_HAS_STD_HASH #ifndef EIGEN_HAS_STD_INVOKE_RESULT #if EIGEN_MAX_CPP_VER >= 17 && EIGEN_COMP_CXXVER >= 17 #define EIGEN_HAS_STD_INVOKE_RESULT … #else #define EIGEN_HAS_STD_INVOKE_RESULT … #endif #endif #define EIGEN_CONSTEXPR … // NOTE: the required Apple's clang version is very conservative // and it could be that XCode 9 works just fine. // NOTE: the MSVC version is based on https://en.cppreference.com/w/cpp/compiler_support // and not tested. // NOTE: Intel C++ Compiler Classic (icc) Version 19.0 and later supports dynamic allocation // for over-aligned data, but not in a manner that is compatible with Eigen. // See https://gitlab.com/libeigen/eigen/-/issues/2575 #ifndef EIGEN_HAS_CXX17_OVERALIGN #if EIGEN_MAX_CPP_VER >= 17 && EIGEN_COMP_CXXVER >= 17 && \ ((EIGEN_COMP_MSVC >= 1912) || (EIGEN_GNUC_STRICT_AT_LEAST(7, 0, 0)) || (EIGEN_CLANG_STRICT_AT_LEAST(5, 0, 0)) || \ (EIGEN_COMP_CLANGAPPLE && EIGEN_COMP_CLANGAPPLE >= 10000000)) && \ !EIGEN_COMP_ICC #define EIGEN_HAS_CXX17_OVERALIGN … #else #define EIGEN_HAS_CXX17_OVERALIGN … #endif #endif #if defined(EIGEN_CUDACC) // While available already with c++11, this is useful mostly starting with c++14 and relaxed constexpr rules #if defined(__NVCC__) // nvcc considers constexpr functions as __host__ __device__ with the option --expt-relaxed-constexpr #ifdef __CUDACC_RELAXED_CONSTEXPR__ #define EIGEN_CONSTEXPR_ARE_DEVICE_FUNC #endif #elif defined(__clang__) && defined(__CUDA__) && __has_feature(cxx_relaxed_constexpr) // clang++ always considers constexpr functions as implicitly __host__ __device__ #define EIGEN_CONSTEXPR_ARE_DEVICE_FUNC #endif #endif // Does the compiler support the __int128 and __uint128_t extensions for 128-bit // integer arithmetic? // // Clang and GCC define __SIZEOF_INT128__ when these extensions are supported, // but we avoid using them in certain cases: // // * Building using Clang for Windows, where the Clang runtime library has // 128-bit support only on LP64 architectures, but Windows is LLP64. #ifndef EIGEN_HAS_BUILTIN_INT128 #if defined(__SIZEOF_INT128__) && !(EIGEN_OS_WIN && EIGEN_COMP_CLANG) #define EIGEN_HAS_BUILTIN_INT128 … #else #define EIGEN_HAS_BUILTIN_INT128 … #endif #endif //------------------------------------------------------------------------------------------ // Preprocessor programming helpers //------------------------------------------------------------------------------------------ // This macro can be used to prevent from macro expansion, e.g.: // std::max EIGEN_NOT_A_MACRO(a,b) #define EIGEN_NOT_A_MACRO #define EIGEN_DEBUG_VAR(x) … // concatenate two tokens #define EIGEN_CAT2(a, b) … #define EIGEN_CAT(a, b) … #define EIGEN_COMMA … // convert a token to a string #define EIGEN_MAKESTRING2(a) … #define EIGEN_MAKESTRING(a) … // EIGEN_STRONG_INLINE is a stronger version of the inline, using __forceinline on MSVC, // but it still doesn't use GCC's always_inline. This is useful in (common) situations where MSVC needs forceinline // but GCC is still doing fine with just inline. #ifndef EIGEN_STRONG_INLINE #if (EIGEN_COMP_MSVC || EIGEN_COMP_ICC) && !defined(EIGEN_GPUCC) #define EIGEN_STRONG_INLINE … #else #define EIGEN_STRONG_INLINE … #endif #endif // EIGEN_ALWAYS_INLINE is the strongest, it has the effect of making the function inline and adding every possible // attribute to maximize inlining. This should only be used when really necessary: in particular, // it uses __attribute__((always_inline)) on GCC, which most of the time is useless and can severely harm compile times. // FIXME with the always_inline attribute, #if EIGEN_COMP_GNUC && !defined(SYCL_DEVICE_ONLY) #define EIGEN_ALWAYS_INLINE … #else #define EIGEN_ALWAYS_INLINE … #endif #if EIGEN_COMP_GNUC #define EIGEN_DONT_INLINE … #elif EIGEN_COMP_MSVC #define EIGEN_DONT_INLINE … #else #define EIGEN_DONT_INLINE #endif #if EIGEN_COMP_GNUC #define EIGEN_PERMISSIVE_EXPR … #else #define EIGEN_PERMISSIVE_EXPR #endif // GPU stuff // Disable some features when compiling with GPU compilers (SYCL/HIPCC) #if defined(SYCL_DEVICE_ONLY) || defined(EIGEN_HIP_DEVICE_COMPILE) // Do not try asserts on device code #ifndef EIGEN_NO_DEBUG #define EIGEN_NO_DEBUG #endif #ifdef EIGEN_INTERNAL_DEBUGGING #undef EIGEN_INTERNAL_DEBUGGING #endif #endif // No exceptions on device. #if defined(SYCL_DEVICE_ONLY) || defined(EIGEN_GPU_COMPILE_PHASE) #ifdef EIGEN_EXCEPTIONS #undef EIGEN_EXCEPTIONS #endif #endif #if defined(SYCL_DEVICE_ONLY) #ifndef EIGEN_DONT_VECTORIZE #define EIGEN_DONT_VECTORIZE #endif #define EIGEN_DEVICE_FUNC … // All functions callable from CUDA/HIP code must be qualified with __device__ #elif defined(EIGEN_GPUCC) #define EIGEN_DEVICE_FUNC … #else #define EIGEN_DEVICE_FUNC #endif // this macro allows to get rid of linking errors about multiply defined functions. // - static is not very good because it prevents definitions from different object files to be merged. // So static causes the resulting linked executable to be bloated with multiple copies of the same function. // - inline is not perfect either as it unwantedly hints the compiler toward inlining the function. #define EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS … #define EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS … #ifdef NDEBUG #ifndef EIGEN_NO_DEBUG #define EIGEN_NO_DEBUG #endif #endif // eigen_assert can be overridden #ifndef eigen_assert #define eigen_assert(x) … #endif #ifdef EIGEN_INTERNAL_DEBUGGING #define eigen_internal_assert … #else #define eigen_internal_assert(x) … #endif #if defined(EIGEN_NO_DEBUG) || (defined(EIGEN_GPU_COMPILE_PHASE) && defined(EIGEN_NO_DEBUG_GPU)) #define EIGEN_ONLY_USED_FOR_DEBUG … #else #define EIGEN_ONLY_USED_FOR_DEBUG(x) … #endif #ifndef EIGEN_NO_DEPRECATED_WARNING #if EIGEN_COMP_GNUC #define EIGEN_DEPRECATED … #elif EIGEN_COMP_MSVC #define EIGEN_DEPRECATED … #else #define EIGEN_DEPRECATED #endif #else #define EIGEN_DEPRECATED #endif #if EIGEN_COMP_GNUC #define EIGEN_UNUSED … #else #define EIGEN_UNUSED #endif #if EIGEN_COMP_GNUC #define EIGEN_PRAGMA(tokens) … #define EIGEN_DIAGNOSTICS(tokens) … #define EIGEN_DIAGNOSTICS_OFF(msc, gcc) … #elif EIGEN_COMP_MSVC #define EIGEN_PRAGMA … #define EIGEN_DIAGNOSTICS … #define EIGEN_DIAGNOSTICS_OFF … #else #define EIGEN_PRAGMA … #define EIGEN_DIAGNOSTICS … #define EIGEN_DIAGNOSTICS_OFF … #endif #define EIGEN_DISABLE_DEPRECATED_WARNING … // Suppresses 'unused variable' warnings. namespace Eigen { namespace internal { template <typename T> EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE constexpr void ignore_unused_variable(const T&) { … } } // namespace internal } // namespace Eigen #define EIGEN_UNUSED_VARIABLE(var) … #if !defined(EIGEN_ASM_COMMENT) #if EIGEN_COMP_GNUC && (EIGEN_ARCH_i386_OR_x86_64 || EIGEN_ARCH_ARM_OR_ARM64) #define EIGEN_ASM_COMMENT(X) … #else #define EIGEN_ASM_COMMENT … #endif #endif // Acts as a barrier preventing operations involving `X` from crossing. This // occurs, for example, in the fast rounding trick where a magic constant is // added then subtracted, which is otherwise compiled away with -ffast-math. // // See bug 1674 #if defined(EIGEN_GPU_COMPILE_PHASE) #define EIGEN_OPTIMIZATION_BARRIER … #endif #if !defined(EIGEN_OPTIMIZATION_BARRIER) #if EIGEN_COMP_GNUC // According to https://gcc.gnu.org/onlinedocs/gcc/Constraints.html: // X: Any operand whatsoever. // r: A register operand is allowed provided that it is in a general // register. // g: Any register, memory or immediate integer operand is allowed, except // for registers that are not general registers. // w: (AArch32/AArch64) Floating point register, Advanced SIMD vector // register or SVE vector register. // x: (SSE) Any SSE register. // (AArch64) Like w, but restricted to registers 0 to 15 inclusive. // v: (PowerPC) An Altivec vector register. // wa:(PowerPC) A VSX register. // // "X" (uppercase) should work for all cases, though this seems to fail for // some versions of GCC for arm/aarch64 with // "error: inconsistent operand constraints in an 'asm'" // Clang x86_64/arm/aarch64 seems to require "g" to support both scalars and // vectors, otherwise // "error: non-trivial scalar-to-vector conversion, possible invalid // constraint for vector type" // // GCC for ppc64le generates an internal compiler error with x/X/g. // GCC for AVX generates an internal compiler error with X. // // Tested on icc/gcc/clang for sse, avx, avx2, avx512dq // gcc for arm, aarch64, // gcc for ppc64le, // both vectors and scalars. // // Note that this is restricted to plain types - this will not work // directly for std::complex<T>, Eigen::half, Eigen::bfloat16. For these, // you will need to apply to the underlying POD type. #if EIGEN_ARCH_PPC && EIGEN_COMP_GNUC_STRICT // This seems to be broken on clang. Packet4f is loaded into a single // register rather than a vector, zeroing out some entries. Integer // types also generate a compile error. #if EIGEN_OS_MAC // General, Altivec for Apple (VSX were added in ISA v2.06): #define EIGEN_OPTIMIZATION_BARRIER … #else // General, Altivec, VSX otherwise: #define EIGEN_OPTIMIZATION_BARRIER … #endif #elif EIGEN_ARCH_ARM_OR_ARM64 #ifdef __ARM_FP // General, VFP or NEON. // Clang doesn't like "r", // error: non-trivial scalar-to-vector conversion, possible invalid // constraint for vector typ #define EIGEN_OPTIMIZATION_BARRIER … #else // Arm without VFP or NEON. // "w" constraint will not compile. #define EIGEN_OPTIMIZATION_BARRIER … #endif #elif EIGEN_ARCH_i386_OR_x86_64 // General, SSE. #define EIGEN_OPTIMIZATION_BARRIER(X) … #else // Not implemented for other architectures. #define EIGEN_OPTIMIZATION_BARRIER … #endif #else // Not implemented for other compilers. #define EIGEN_OPTIMIZATION_BARRIER … #endif #endif #if EIGEN_COMP_MSVC // NOTE MSVC often gives C4127 warnings with compiletime if statements. See bug 1362. // This workaround is ugly, but it does the job. #define EIGEN_CONST_CONDITIONAL … #else #define EIGEN_CONST_CONDITIONAL(cond) … #endif #ifdef EIGEN_DONT_USE_RESTRICT_KEYWORD #define EIGEN_RESTRICT #endif #ifndef EIGEN_RESTRICT #define EIGEN_RESTRICT … #endif #ifndef EIGEN_DEFAULT_IO_FORMAT #ifdef EIGEN_MAKING_DOCS // format used in Eigen's documentation // needed to define it here as escaping characters in CMake add_definition's argument seems very problematic. #define EIGEN_DEFAULT_IO_FORMAT … #else #define EIGEN_DEFAULT_IO_FORMAT … #endif #endif // just an empty macro ! #define EIGEN_EMPTY // When compiling CUDA/HIP device code with NVCC or HIPCC // pull in math functions from the global namespace. // In host mode, and when device code is compiled with clang, // use the std versions. #if (defined(EIGEN_CUDA_ARCH) && defined(__NVCC__)) || defined(EIGEN_HIP_DEVICE_COMPILE) #define EIGEN_USING_STD … #else #define EIGEN_USING_STD(FUNC) … #endif #if EIGEN_COMP_MSVC_STRICT && EIGEN_COMP_NVCC // Wwhen compiling with NVCC, using the base operator is necessary, // otherwise we get duplicate definition errors // For later MSVC versions, we require explicit operator= definition, otherwise we get // use of implicitly deleted operator errors. // (cf Bugs 920, 1000, 1324, 2291) #define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR … #elif EIGEN_COMP_CLANG // workaround clang bug (see http://forum.kde.org/viewtopic.php?f=74&t=102653) #define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived) … #else #define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR … #endif /** * \internal * \brief Macro to explicitly define the default copy constructor. * This is necessary, because the implicit definition is deprecated if the copy-assignment is overridden. */ #define EIGEN_DEFAULT_COPY_CONSTRUCTOR(CLASS) … /** \internal * \brief Macro to manually inherit assignment operators. * This is necessary, because the implicitly defined assignment operator gets deleted when a custom operator= is * defined. With C++11 or later this also default-implements the copy-constructor */ #define EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Derived) … /** \internal * \brief Macro to manually define default constructors and destructors. * This is necessary when the copy constructor is re-defined. * For empty helper classes this should usually be protected, to avoid accidentally creating empty objects. * * Hiding the default destructor lead to problems in C++03 mode together with boost::multiprecision */ #define EIGEN_DEFAULT_EMPTY_CONSTRUCTOR_AND_DESTRUCTOR(Derived) … /** * Just a side note. Commenting within defines works only by documenting * behind the object (via '!<'). Comments cannot be multi-line and thus * we have these extra long lines. What is confusing doxygen over here is * that we use '\' and basically have a bunch of typedefs with their * documentation in a single line. **/ #define EIGEN_GENERIC_PUBLIC_INTERFACE(Derived) … // FIXME Maybe the EIGEN_DENSE_PUBLIC_INTERFACE could be removed as importing PacketScalar is rarely needed #define EIGEN_DENSE_PUBLIC_INTERFACE(Derived) … #if EIGEN_HAS_BUILTIN(__builtin_expect) || EIGEN_COMP_GNUC #define EIGEN_PREDICT_FALSE(x) … #define EIGEN_PREDICT_TRUE(x) … #else #define EIGEN_PREDICT_FALSE … #define EIGEN_PREDICT_TRUE … #endif // the expression type of a standard coefficient wise binary operation #define EIGEN_CWISE_BINARY_RETURN_TYPE(LHS, RHS, OPNAME) … #define EIGEN_MAKE_CWISE_BINARY_OP(METHOD, OPNAME) … #define EIGEN_SCALAR_BINARY_SUPPORTED(OPNAME, TYPEA, TYPEB) … #define EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(EXPR, SCALAR, OPNAME) … #define EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(SCALAR, EXPR, OPNAME) … #define EIGEN_MAKE_SCALAR_BINARY_OP_ONTHERIGHT(METHOD, OPNAME) … #define EIGEN_MAKE_SCALAR_BINARY_OP_ONTHELEFT(METHOD, OPNAME) … #define EIGEN_MAKE_SCALAR_BINARY_OP(METHOD, OPNAME) … #if (defined(_CPPUNWIND) || defined(__EXCEPTIONS)) && !defined(EIGEN_CUDA_ARCH) && !defined(EIGEN_EXCEPTIONS) && \ !defined(EIGEN_USE_SYCL) && !defined(EIGEN_HIP_DEVICE_COMPILE) #define EIGEN_EXCEPTIONS #endif #ifdef EIGEN_EXCEPTIONS #define EIGEN_THROW_X … #define EIGEN_THROW … #define EIGEN_TRY … #define EIGEN_CATCH … #else #if defined(EIGEN_CUDA_ARCH) #define EIGEN_THROW_X … #define EIGEN_THROW … #elif defined(EIGEN_HIP_DEVICE_COMPILE) #define EIGEN_THROW_X … #define EIGEN_THROW … #else #define EIGEN_THROW_X(X) … #define EIGEN_THROW … #endif #define EIGEN_TRY … #define EIGEN_CATCH(X) … #endif #define EIGEN_NOEXCEPT … #define EIGEN_NOEXCEPT_IF(x) … #define EIGEN_NO_THROW … #define EIGEN_EXCEPTION_SPEC(X) … // The all function is used to enable a variadic version of eigen_assert which can take a parameter pack as its input. namespace Eigen { namespace internal { EIGEN_DEVICE_FUNC inline bool all() { … } template <typename T, typename... Ts> EIGEN_DEVICE_FUNC bool all(T t, Ts... ts) { … } } // namespace internal } // namespace Eigen // provide override and final specifiers if they are available: #define EIGEN_OVERRIDE … #define EIGEN_FINAL … // Wrapping #pragma unroll in a macro since it is required for SYCL #if defined(SYCL_DEVICE_ONLY) #if defined(_MSC_VER) #define EIGEN_UNROLL_LOOP … #else #define EIGEN_UNROLL_LOOP … #endif #else #define EIGEN_UNROLL_LOOP #endif // Notice: Use this macro with caution. The code in the if body should still // compile with C++14. #if defined(EIGEN_HAS_CXX17_IFCONSTEXPR) #define EIGEN_IF_CONSTEXPR … #else #define EIGEN_IF_CONSTEXPR(X) … #endif #endif // EIGEN_MACROS_H
Codebase Browser
chromium