Eigen  3.2.93
Macros.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008-2015 Gael Guennebaud <gael.guennebaud@inria.fr>
5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // This Source Code Form is subject to the terms of the Mozilla
8 // Public License v. 2.0. If a copy of the MPL was not distributed
9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 
11 #ifndef EIGEN_MACROS_H
12 #define EIGEN_MACROS_H
13 
14 #define EIGEN_WORLD_VERSION 3
15 #define EIGEN_MAJOR_VERSION 2
16 #define EIGEN_MINOR_VERSION 93
17 
18 #define EIGEN_VERSION_AT_LEAST(x,y,z) (EIGEN_WORLD_VERSION>x || (EIGEN_WORLD_VERSION>=x && \
19  (EIGEN_MAJOR_VERSION>y || (EIGEN_MAJOR_VERSION>=y && \
20  EIGEN_MINOR_VERSION>=z))))
21 
22 // Compiler identification, EIGEN_COMP_*
23 
25 #ifdef __GNUC__
26  #define EIGEN_COMP_GNUC 1
27 #else
28  #define EIGEN_COMP_GNUC 0
29 #endif
30 
32 #if defined(__clang__)
33  #define EIGEN_COMP_CLANG 1
34 #else
35  #define EIGEN_COMP_CLANG 0
36 #endif
37 
38 
40 #if defined(__llvm__)
41  #define EIGEN_COMP_LLVM 1
42 #else
43  #define EIGEN_COMP_LLVM 0
44 #endif
45 
47 #if defined(__INTEL_COMPILER)
48  #define EIGEN_COMP_ICC __INTEL_COMPILER
49 #else
50  #define EIGEN_COMP_ICC 0
51 #endif
52 
54 #if defined(__MINGW32__)
55  #define EIGEN_COMP_MINGW 1
56 #else
57  #define EIGEN_COMP_MINGW 0
58 #endif
59 
61 #if defined(__SUNPRO_CC)
62  #define EIGEN_COMP_SUNCC 1
63 #else
64  #define EIGEN_COMP_SUNCC 0
65 #endif
66 
68 #if defined(_MSC_VER)
69  #define EIGEN_COMP_MSVC _MSC_VER
70 #else
71  #define EIGEN_COMP_MSVC 0
72 #endif
73 
74 // For the record, here is a table summarizing the possible values for EIGEN_COMP_MSVC:
75 // name ver MSC_VER
76 // 2008 9 1500
77 // 2010 10 1600
78 // 2012 11 1700
79 // 2013 12 1800
80 // 2015 14 1900
81 // "15" 15 1900
82 
84 #if EIGEN_COMP_MSVC && !(EIGEN_COMP_ICC)
85  #define EIGEN_COMP_MSVC_STRICT _MSC_VER
86 #else
87  #define EIGEN_COMP_MSVC_STRICT 0
88 #endif
89 
91 #if defined(__IBMCPP__) || defined(__xlc__)
92  #define EIGEN_COMP_IBM 1
93 #else
94  #define EIGEN_COMP_IBM 0
95 #endif
96 
98 #if defined(__PGI)
99  #define EIGEN_COMP_PGI 1
100 #else
101  #define EIGEN_COMP_PGI 0
102 #endif
103 
105 #if defined(__CC_ARM) || defined(__ARMCC_VERSION)
106  #define EIGEN_COMP_ARM 1
107 #else
108  #define EIGEN_COMP_ARM 0
109 #endif
110 
112 #if defined(__EMSCRIPTEN__)
113  #define EIGEN_COMP_EMSCRIPTEN 1
114 #else
115  #define EIGEN_COMP_EMSCRIPTEN 0
116 #endif
117 
118 
120 #if EIGEN_COMP_GNUC && !(EIGEN_COMP_CLANG || EIGEN_COMP_ICC || EIGEN_COMP_MINGW || EIGEN_COMP_PGI || EIGEN_COMP_IBM || EIGEN_COMP_ARM || EIGEN_COMP_EMSCRIPTEN)
121  #define EIGEN_COMP_GNUC_STRICT 1
122 #else
123  #define EIGEN_COMP_GNUC_STRICT 0
124 #endif
125 
126 
127 #if EIGEN_COMP_GNUC
128  #define EIGEN_GNUC_AT_LEAST(x,y) ((__GNUC__==x && __GNUC_MINOR__>=y) || __GNUC__>x)
129  #define EIGEN_GNUC_AT_MOST(x,y) ((__GNUC__==x && __GNUC_MINOR__<=y) || __GNUC__<x)
130  #define EIGEN_GNUC_AT(x,y) ( __GNUC__==x && __GNUC_MINOR__==y )
131 #else
132  #define EIGEN_GNUC_AT_LEAST(x,y) 0
133  #define EIGEN_GNUC_AT_MOST(x,y) 0
134  #define EIGEN_GNUC_AT(x,y) 0
135 #endif
136 
137 // FIXME: could probably be removed as we do not support gcc 3.x anymore
138 #if EIGEN_COMP_GNUC && (__GNUC__ <= 3)
139 #define EIGEN_GCC3_OR_OLDER 1
140 #else
141 #define EIGEN_GCC3_OR_OLDER 0
142 #endif
143 
144 
145 // Architecture identification, EIGEN_ARCH_*
146 
147 #if defined(__x86_64__) || defined(_M_X64) || defined(__amd64)
148  #define EIGEN_ARCH_x86_64 1
149 #else
150  #define EIGEN_ARCH_x86_64 0
151 #endif
152 
153 #if defined(__i386__) || defined(_M_IX86) || defined(_X86_) || defined(__i386)
154  #define EIGEN_ARCH_i386 1
155 #else
156  #define EIGEN_ARCH_i386 0
157 #endif
158 
159 #if EIGEN_ARCH_x86_64 || EIGEN_ARCH_i386
160  #define EIGEN_ARCH_i386_OR_x86_64 1
161 #else
162  #define EIGEN_ARCH_i386_OR_x86_64 0
163 #endif
164 
166 #if defined(__arm__)
167  #define EIGEN_ARCH_ARM 1
168 #else
169  #define EIGEN_ARCH_ARM 0
170 #endif
171 
173 #if defined(__aarch64__)
174  #define EIGEN_ARCH_ARM64 1
175 #else
176  #define EIGEN_ARCH_ARM64 0
177 #endif
178 
179 #if EIGEN_ARCH_ARM || EIGEN_ARCH_ARM64
180  #define EIGEN_ARCH_ARM_OR_ARM64 1
181 #else
182  #define EIGEN_ARCH_ARM_OR_ARM64 0
183 #endif
184 
186 #if defined(__mips__) || defined(__mips)
187  #define EIGEN_ARCH_MIPS 1
188 #else
189  #define EIGEN_ARCH_MIPS 0
190 #endif
191 
193 #if defined(__sparc__) || defined(__sparc)
194  #define EIGEN_ARCH_SPARC 1
195 #else
196  #define EIGEN_ARCH_SPARC 0
197 #endif
198 
200 #if defined(__ia64__)
201  #define EIGEN_ARCH_IA64 1
202 #else
203  #define EIGEN_ARCH_IA64 0
204 #endif
205 
207 #if defined(__powerpc__) || defined(__ppc__) || defined(_M_PPC)
208  #define EIGEN_ARCH_PPC 1
209 #else
210  #define EIGEN_ARCH_PPC 0
211 #endif
212 
213 
214 
215 // Operating system identification, EIGEN_OS_*
216 
218 #if defined(__unix__) || defined(__unix)
219  #define EIGEN_OS_UNIX 1
220 #else
221  #define EIGEN_OS_UNIX 0
222 #endif
223 
225 #if defined(__linux__)
226  #define EIGEN_OS_LINUX 1
227 #else
228  #define EIGEN_OS_LINUX 0
229 #endif
230 
232 // note: ANDROID is defined when using ndk_build, __ANDROID__ is defined when using a standalone toolchain.
233 #if defined(__ANDROID__) || defined(ANDROID)
234  #define EIGEN_OS_ANDROID 1
235 #else
236  #define EIGEN_OS_ANDROID 0
237 #endif
238 
240 #if defined(__gnu_linux__) && !(EIGEN_OS_ANDROID)
241  #define EIGEN_OS_GNULINUX 1
242 #else
243  #define EIGEN_OS_GNULINUX 0
244 #endif
245 
247 #if defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__bsdi__) || defined(__DragonFly__)
248  #define EIGEN_OS_BSD 1
249 #else
250  #define EIGEN_OS_BSD 0
251 #endif
252 
254 #if defined(__APPLE__)
255  #define EIGEN_OS_MAC 1
256 #else
257  #define EIGEN_OS_MAC 0
258 #endif
259 
261 #if defined(__QNX__)
262  #define EIGEN_OS_QNX 1
263 #else
264  #define EIGEN_OS_QNX 0
265 #endif
266 
268 #if defined(_WIN32)
269  #define EIGEN_OS_WIN 1
270 #else
271  #define EIGEN_OS_WIN 0
272 #endif
273 
275 #if defined(_WIN64)
276  #define EIGEN_OS_WIN64 1
277 #else
278  #define EIGEN_OS_WIN64 0
279 #endif
280 
282 #if defined(_WIN32_WCE)
283  #define EIGEN_OS_WINCE 1
284 #else
285  #define EIGEN_OS_WINCE 0
286 #endif
287 
289 #if defined(__CYGWIN__)
290  #define EIGEN_OS_CYGWIN 1
291 #else
292  #define EIGEN_OS_CYGWIN 0
293 #endif
294 
296 #if EIGEN_OS_WIN && !( EIGEN_OS_WINCE || EIGEN_OS_CYGWIN )
297  #define EIGEN_OS_WIN_STRICT 1
298 #else
299  #define EIGEN_OS_WIN_STRICT 0
300 #endif
301 
303 #if (defined(sun) || defined(__sun)) && !(defined(__SVR4) || defined(__svr4__))
304  #define EIGEN_OS_SUN 1
305 #else
306  #define EIGEN_OS_SUN 0
307 #endif
308 
310 #if (defined(sun) || defined(__sun)) && (defined(__SVR4) || defined(__svr4__))
311  #define EIGEN_OS_SOLARIS 1
312 #else
313  #define EIGEN_OS_SOLARIS 0
314 #endif
315 
316 
317 
318 #if EIGEN_GNUC_AT_MOST(4,3) && !EIGEN_COMP_CLANG
319  // see bug 89
320  #define EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO 0
321 #else
322  #define EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO 1
323 #endif
324 
325 // This macro can be used to prevent from macro expansion, e.g.:
326 // std::max EIGEN_NOT_A_MACRO(a,b)
327 #define EIGEN_NOT_A_MACRO
328 
329 #ifdef EIGEN_DEFAULT_TO_ROW_MAJOR
330 #define EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION Eigen::RowMajor
331 #else
332 #define EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION Eigen::ColMajor
333 #endif
334 
335 #ifndef EIGEN_DEFAULT_DENSE_INDEX_TYPE
336 #define EIGEN_DEFAULT_DENSE_INDEX_TYPE std::ptrdiff_t
337 #endif
338 
339 // Cross compiler wrapper around LLVM's __has_builtin
340 #ifdef __has_builtin
341 # define EIGEN_HAS_BUILTIN(x) __has_builtin(x)
342 #else
343 # define EIGEN_HAS_BUILTIN(x) 0
344 #endif
345 
346 // A Clang feature extension to determine compiler features.
347 // We use it to determine 'cxx_rvalue_references'
348 #ifndef __has_feature
349 # define __has_feature(x) 0
350 #endif
351 
352 // Upperbound on the C++ version to use.
353 // Expected values are 03, 11, 14, 17, etc.
354 // By default, let's use an arbitrarily large C++ version.
355 #ifndef EIGEN_MAX_CPP_VER
356 #define EIGEN_MAX_CPP_VER 99
357 #endif
358 
359 // Do we support r-value references?
360 #ifndef EIGEN_HAS_RVALUE_REFERENCES
361 #if EIGEN_MAX_CPP_VER>=11 && \
362  (__has_feature(cxx_rvalue_references) || \
363  (defined(__cplusplus) && __cplusplus >= 201103L) || \
364  (EIGEN_COMP_MSVC >= 1600))
365  #define EIGEN_HAS_RVALUE_REFERENCES 1
366 #else
367  #define EIGEN_HAS_RVALUE_REFERENCES 0
368 #endif
369 #endif
370 
371 // Does the compiler support C99?
372 #ifndef EIGEN_HAS_C99_MATH
373 #if EIGEN_MAX_CPP_VER>=11 && \
374  ((defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901)) \
375  || (defined(__GNUC__) && defined(_GLIBCXX_USE_C99)) \
376  || (defined(_LIBCPP_VERSION) && !defined(_MSC_VER)))
377  #define EIGEN_HAS_C99_MATH 1
378 #else
379  #define EIGEN_HAS_C99_MATH 0
380 #endif
381 #endif
382 
383 // Does the compiler support result_of?
384 #ifndef EIGEN_HAS_STD_RESULT_OF
385 #if EIGEN_MAX_CPP_VER>=11 && ((__has_feature(cxx_lambdas) || (defined(__cplusplus) && __cplusplus >= 201103L)))
386 #define EIGEN_HAS_STD_RESULT_OF 1
387 #else
388 #define EIGEN_HAS_STD_RESULT_OF 0
389 #endif
390 #endif
391 
392 // Does the compiler support variadic templates?
393 #ifndef EIGEN_HAS_VARIADIC_TEMPLATES
394 #if EIGEN_MAX_CPP_VER>=11 && (__cplusplus > 199711L || EIGEN_COMP_MSVC >= 1900) \
395  && ( !defined(__NVCC__) || !EIGEN_ARCH_ARM_OR_ARM64 )
396  // ^^ Disable the use of variadic templates when compiling with nvcc on ARM devices:
397  // this prevents nvcc from crashing when compiling Eigen on Tegra X1
398 #define EIGEN_HAS_VARIADIC_TEMPLATES 1
399 #else
400 #define EIGEN_HAS_VARIADIC_TEMPLATES 0
401 #endif
402 #endif
403 
404 // Does the compiler fully support const expressions? (as in c++14)
405 #ifndef EIGEN_HAS_CONSTEXPR
406 
407 #ifdef __CUDACC__
408 // Const expressions are supported provided that c++11 is enabled and we're using either clang or nvcc 7.5 or above
409 #if EIGEN_MAX_CPP_VER>=14 && (__cplusplus > 199711L && defined(__CUDACC_VER__) && (EIGEN_COMP_CLANG || __CUDACC_VER__ >= 70500))
410  #define EIGEN_HAS_CONSTEXPR 1
411 #endif
412 #elif EIGEN_MAX_CPP_VER>=14 && (__has_feature(cxx_relaxed_constexpr) || (defined(__cplusplus) && __cplusplus >= 201402L) || \
413  (EIGEN_GNUC_AT_LEAST(4,8) && (__cplusplus > 199711L)))
414 #define EIGEN_HAS_CONSTEXPR 1
415 #endif
416 
417 #ifndef EIGEN_HAS_CONSTEXPR
418 #define EIGEN_HAS_CONSTEXPR 0
419 #endif
420 
421 #endif
422 
423 // Does the compiler support C++11 math?
424 // Let's be conservative and enable the default C++11 implementation only if we are sure it exists
425 #ifndef EIGEN_HAS_CXX11_MATH
426  #if EIGEN_MAX_CPP_VER>=11 && ((__cplusplus > 201103L) || (__cplusplus >= 201103L) && (EIGEN_COMP_GNUC_STRICT || EIGEN_COMP_CLANG || EIGEN_COMP_MSVC || EIGEN_COMP_ICC) \
427  && (EIGEN_ARCH_i386_OR_x86_64) && (EIGEN_OS_GNULINUX || EIGEN_OS_WIN_STRICT || EIGEN_OS_MAC))
428  #define EIGEN_HAS_CXX11_MATH 1
429  #else
430  #define EIGEN_HAS_CXX11_MATH 0
431  #endif
432 #endif
433 
434 // Does the compiler support proper C++11 containers?
435 #ifndef EIGEN_HAS_CXX11_CONTAINERS
436  #if EIGEN_MAX_CPP_VER>=11 && \
437  ((__cplusplus > 201103L) \
438  || ((__cplusplus >= 201103L) && (EIGEN_COMP_GNUC_STRICT || EIGEN_COMP_CLANG || EIGEN_COMP_ICC>=1400)) \
439  || EIGEN_COMP_MSVC >= 1900)
440  #define EIGEN_HAS_CXX11_CONTAINERS 1
441  #else
442  #define EIGEN_HAS_CXX11_CONTAINERS 0
443  #endif
444 #endif
445 
446 // Does the compiler support C++11 noexcept?
447 #ifndef EIGEN_HAS_CXX11_NOEXCEPT
448  #if EIGEN_MAX_CPP_VER>=11 && \
449  (__has_feature(cxx_noexcept) \
450  || (__cplusplus > 201103L) \
451  || ((__cplusplus >= 201103L) && (EIGEN_COMP_GNUC_STRICT || EIGEN_COMP_CLANG || EIGEN_COMP_ICC>=1400)) \
452  || EIGEN_COMP_MSVC >= 1900)
453  #define EIGEN_HAS_CXX11_NOEXCEPT 1
454  #else
455  #define EIGEN_HAS_CXX11_NOEXCEPT 0
456  #endif
457 #endif
458 
464 #ifndef EIGEN_FAST_MATH
465 #define EIGEN_FAST_MATH 1
466 #endif
467 
468 #define EIGEN_DEBUG_VAR(x) std::cerr << #x << " = " << x << std::endl;
469 
470 // concatenate two tokens
471 #define EIGEN_CAT2(a,b) a ## b
472 #define EIGEN_CAT(a,b) EIGEN_CAT2(a,b)
473 
474 #define EIGEN_COMMA ,
475 
476 // convert a token to a string
477 #define EIGEN_MAKESTRING2(a) #a
478 #define EIGEN_MAKESTRING(a) EIGEN_MAKESTRING2(a)
479 
480 // EIGEN_STRONG_INLINE is a stronger version of the inline, using __forceinline on MSVC,
481 // but it still doesn't use GCC's always_inline. This is useful in (common) situations where MSVC needs forceinline
482 // but GCC is still doing fine with just inline.
483 #if EIGEN_COMP_MSVC || EIGEN_COMP_ICC
484 #define EIGEN_STRONG_INLINE __forceinline
485 #else
486 #define EIGEN_STRONG_INLINE inline
487 #endif
488 
489 // EIGEN_ALWAYS_INLINE is the stronget, it has the effect of making the function inline and adding every possible
490 // attribute to maximize inlining. This should only be used when really necessary: in particular,
491 // it uses __attribute__((always_inline)) on GCC, which most of the time is useless and can severely harm compile times.
492 // FIXME with the always_inline attribute,
493 // gcc 3.4.x reports the following compilation error:
494 // Eval.h:91: sorry, unimplemented: inlining failed in call to 'const Eigen::Eval<Derived> Eigen::MatrixBase<Scalar, Derived>::eval() const'
495 // : function body not available
496 #if EIGEN_GNUC_AT_LEAST(4,0)
497 #define EIGEN_ALWAYS_INLINE __attribute__((always_inline)) inline
498 #else
499 #define EIGEN_ALWAYS_INLINE EIGEN_STRONG_INLINE
500 #endif
501 
502 #if EIGEN_COMP_GNUC
503 #define EIGEN_DONT_INLINE __attribute__((noinline))
504 #elif EIGEN_COMP_MSVC
505 #define EIGEN_DONT_INLINE __declspec(noinline)
506 #else
507 #define EIGEN_DONT_INLINE
508 #endif
509 
510 #if EIGEN_COMP_GNUC
511 #define EIGEN_PERMISSIVE_EXPR __extension__
512 #else
513 #define EIGEN_PERMISSIVE_EXPR
514 #endif
515 
516 // this macro allows to get rid of linking errors about multiply defined functions.
517 // - static is not very good because it prevents definitions from different object files to be merged.
518 // So static causes the resulting linked executable to be bloated with multiple copies of the same function.
519 // - inline is not perfect either as it unwantedly hints the compiler toward inlining the function.
520 #define EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS
521 #define EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS inline
522 
523 #ifdef NDEBUG
524 # ifndef EIGEN_NO_DEBUG
525 # define EIGEN_NO_DEBUG
526 # endif
527 #endif
528 
529 // eigen_plain_assert is where we implement the workaround for the assert() bug in GCC <= 4.3, see bug 89
530 #ifdef EIGEN_NO_DEBUG
531  #define eigen_plain_assert(x)
532 #else
533  #if EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO
534  namespace Eigen {
535  namespace internal {
536  inline bool copy_bool(bool b) { return b; }
537  }
538  }
539  #define eigen_plain_assert(x) assert(x)
540  #else
541  // work around bug 89
542  #include <cstdlib> // for abort
543  #include <iostream> // for std::cerr
544 
545  namespace Eigen {
546  namespace internal {
547  // trivial function copying a bool. Must be EIGEN_DONT_INLINE, so we implement it after including Eigen headers.
548  // see bug 89.
549  namespace {
550  EIGEN_DONT_INLINE bool copy_bool(bool b) { return b; }
551  }
552  inline void assert_fail(const char *condition, const char *function, const char *file, int line)
553  {
554  std::cerr << "assertion failed: " << condition << " in function " << function << " at " << file << ":" << line << std::endl;
555  abort();
556  }
557  }
558  }
559  #define eigen_plain_assert(x) \
560  do { \
561  if(!Eigen::internal::copy_bool(x)) \
562  Eigen::internal::assert_fail(EIGEN_MAKESTRING(x), __PRETTY_FUNCTION__, __FILE__, __LINE__); \
563  } while(false)
564  #endif
565 #endif
566 
567 // eigen_assert can be overridden
568 #ifndef eigen_assert
569 #define eigen_assert(x) eigen_plain_assert(x)
570 #endif
571 
572 #ifdef EIGEN_INTERNAL_DEBUGGING
573 #define eigen_internal_assert(x) eigen_assert(x)
574 #else
575 #define eigen_internal_assert(x)
576 #endif
577 
578 #ifdef EIGEN_NO_DEBUG
579 #define EIGEN_ONLY_USED_FOR_DEBUG(x) EIGEN_UNUSED_VARIABLE(x)
580 #else
581 #define EIGEN_ONLY_USED_FOR_DEBUG(x)
582 #endif
583 
584 #ifndef EIGEN_NO_DEPRECATED_WARNING
585  #if EIGEN_COMP_GNUC
586  #define EIGEN_DEPRECATED __attribute__((deprecated))
587  #elif EIGEN_COMP_MSVC
588  #define EIGEN_DEPRECATED __declspec(deprecated)
589  #else
590  #define EIGEN_DEPRECATED
591  #endif
592 #else
593  #define EIGEN_DEPRECATED
594 #endif
595 
596 #if EIGEN_COMP_GNUC
597 #define EIGEN_UNUSED __attribute__((unused))
598 #else
599 #define EIGEN_UNUSED
600 #endif
601 
602 // Suppresses 'unused variable' warnings.
603 namespace Eigen {
604  namespace internal {
605  template<typename T> EIGEN_DEVICE_FUNC void ignore_unused_variable(const T&) {}
606  }
607 }
608 #define EIGEN_UNUSED_VARIABLE(var) Eigen::internal::ignore_unused_variable(var);
609 
610 #if !defined(EIGEN_ASM_COMMENT)
611  #if EIGEN_COMP_GNUC && (EIGEN_ARCH_i386_OR_x86_64 || EIGEN_ARCH_ARM_OR_ARM64)
612  #define EIGEN_ASM_COMMENT(X) __asm__("#" X)
613  #else
614  #define EIGEN_ASM_COMMENT(X)
615  #endif
616 #endif
617 
618 
619 //------------------------------------------------------------------------------------------
620 // Static and dynamic alignment control
621 //
622 // The main purpose of this section is to define EIGEN_MAX_ALIGN_BYTES and EIGEN_MAX_STATIC_ALIGN_BYTES
623 // as the maximal boundary in bytes on which dynamically and statically allocated data may be alignment respectively.
624 // The values of EIGEN_MAX_ALIGN_BYTES and EIGEN_MAX_STATIC_ALIGN_BYTES can be specified by the user. If not,
625 // a default value is automatically computed based on architecture, compiler, and OS.
626 //
627 // This section also defines macros EIGEN_ALIGN_TO_BOUNDARY(N) and the shortcuts EIGEN_ALIGN{8,16,32,_MAX}
628 // to be used to declare statically aligned buffers.
629 //------------------------------------------------------------------------------------------
630 
631 
632 /* EIGEN_ALIGN_TO_BOUNDARY(n) forces data to be n-byte aligned. This is used to satisfy SIMD requirements.
633  * However, we do that EVEN if vectorization (EIGEN_VECTORIZE) is disabled,
634  * so that vectorization doesn't affect binary compatibility.
635  *
636  * If we made alignment depend on whether or not EIGEN_VECTORIZE is defined, it would be impossible to link
637  * vectorized and non-vectorized code.
638  */
639 #if (defined __CUDACC__)
640  #define EIGEN_ALIGN_TO_BOUNDARY(n) __align__(n)
641 #elif EIGEN_COMP_GNUC || EIGEN_COMP_PGI || EIGEN_COMP_IBM || EIGEN_COMP_ARM
642  #define EIGEN_ALIGN_TO_BOUNDARY(n) __attribute__((aligned(n)))
643 #elif EIGEN_COMP_MSVC
644  #define EIGEN_ALIGN_TO_BOUNDARY(n) __declspec(align(n))
645 #elif EIGEN_COMP_SUNCC
646  // FIXME not sure about this one:
647  #define EIGEN_ALIGN_TO_BOUNDARY(n) __attribute__((aligned(n)))
648 #else
649  #error Please tell me what is the equivalent of __attribute__((aligned(n))) for your compiler
650 #endif
651 
652 // If the user explicitly disable vectorization, then we also disable alignment
653 #if defined(EIGEN_DONT_VECTORIZE)
654  #define EIGEN_IDEAL_MAX_ALIGN_BYTES 0
655 #elif defined(__AVX__)
656  // 32 bytes static alignmeent is preferred only if really required
657  #define EIGEN_IDEAL_MAX_ALIGN_BYTES 32
658 #else
659  #define EIGEN_IDEAL_MAX_ALIGN_BYTES 16
660 #endif
661 
662 
663 // EIGEN_MIN_ALIGN_BYTES defines the minimal value for which the notion of explicit alignment makes sense
664 #define EIGEN_MIN_ALIGN_BYTES 16
665 
666 // Defined the boundary (in bytes) on which the data needs to be aligned. Note
667 // that unless EIGEN_ALIGN is defined and not equal to 0, the data may not be
668 // aligned at all regardless of the value of this #define.
669 
670 #if (defined(EIGEN_DONT_ALIGN_STATICALLY) || defined(EIGEN_DONT_ALIGN)) && defined(EIGEN_MAX_STATIC_ALIGN_BYTES) && EIGEN_MAX_STATIC_ALIGN_BYTES>0
671 #error EIGEN_MAX_STATIC_ALIGN_BYTES and EIGEN_DONT_ALIGN[_STATICALLY] are both defined with EIGEN_MAX_STATIC_ALIGN_BYTES!=0. Use EIGEN_MAX_STATIC_ALIGN_BYTES=0 as a synonym of EIGEN_DONT_ALIGN_STATICALLY.
672 #endif
673 
674 // EIGEN_DONT_ALIGN_STATICALLY and EIGEN_DONT_ALIGN are deprectated
675 // They imply EIGEN_MAX_STATIC_ALIGN_BYTES=0
676 #if defined(EIGEN_DONT_ALIGN_STATICALLY) || defined(EIGEN_DONT_ALIGN)
677  #ifdef EIGEN_MAX_STATIC_ALIGN_BYTES
678  #undef EIGEN_MAX_STATIC_ALIGN_BYTES
679  #endif
680  #define EIGEN_MAX_STATIC_ALIGN_BYTES 0
681 #endif
682 
683 #ifndef EIGEN_MAX_STATIC_ALIGN_BYTES
684 
685  // Try to automatically guess what is the best default value for EIGEN_MAX_STATIC_ALIGN_BYTES
686 
687  // 16 byte alignment is only useful for vectorization. Since it affects the ABI, we need to enable
688  // 16 byte alignment on all platforms where vectorization might be enabled. In theory we could always
689  // enable alignment, but it can be a cause of problems on some platforms, so we just disable it in
690  // certain common platform (compiler+architecture combinations) to avoid these problems.
691  // Only static alignment is really problematic (relies on nonstandard compiler extensions),
692  // try to keep heap alignment even when we have to disable static alignment.
693  #if EIGEN_COMP_GNUC && !(EIGEN_ARCH_i386_OR_x86_64 || EIGEN_ARCH_ARM_OR_ARM64 || EIGEN_ARCH_PPC || EIGEN_ARCH_IA64)
694  #define EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT 1
695  #elif EIGEN_ARCH_ARM_OR_ARM64 && EIGEN_COMP_GNUC_STRICT && EIGEN_GNUC_AT_MOST(4, 6)
696  // Old versions of GCC on ARM, at least 4.4, were once seen to have buggy static alignment support.
697  // Not sure which version fixed it, hopefully it doesn't affect 4.7, which is still somewhat in use.
698  // 4.8 and newer seem definitely unaffected.
699  #define EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT 1
700  #else
701  #define EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT 0
702  #endif
703 
704  // static alignment is completely disabled with GCC 3, Sun Studio, and QCC/QNX
705  #if !EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT \
706  && !EIGEN_GCC3_OR_OLDER \
707  && !EIGEN_COMP_SUNCC \
708  && !EIGEN_OS_QNX
709  #define EIGEN_ARCH_WANTS_STACK_ALIGNMENT 1
710  #else
711  #define EIGEN_ARCH_WANTS_STACK_ALIGNMENT 0
712  #endif
713 
714  #if EIGEN_ARCH_WANTS_STACK_ALIGNMENT
715  #define EIGEN_MAX_STATIC_ALIGN_BYTES EIGEN_IDEAL_MAX_ALIGN_BYTES
716  #else
717  #define EIGEN_MAX_STATIC_ALIGN_BYTES 0
718  #endif
719 
720 #endif
721 
722 // If EIGEN_MAX_ALIGN_BYTES is defined, then it is considered as an upper bound for EIGEN_MAX_ALIGN_BYTES
723 #if defined(EIGEN_MAX_ALIGN_BYTES) && EIGEN_MAX_ALIGN_BYTES<EIGEN_MAX_STATIC_ALIGN_BYTES
724 #undef EIGEN_MAX_STATIC_ALIGN_BYTES
725 #define EIGEN_MAX_STATIC_ALIGN_BYTES EIGEN_MAX_ALIGN_BYTES
726 #endif
727 
728 #if EIGEN_MAX_STATIC_ALIGN_BYTES==0 && !defined(EIGEN_DISABLE_UNALIGNED_ARRAY_ASSERT)
729  #define EIGEN_DISABLE_UNALIGNED_ARRAY_ASSERT
730 #endif
731 
732 // At this stage, EIGEN_MAX_STATIC_ALIGN_BYTES>0 is the true test whether we want to align arrays on the stack or not.
733 // It takes into account both the user choice to explicitly enable/disable alignment (by settting EIGEN_MAX_STATIC_ALIGN_BYTES)
734 // and the architecture config (EIGEN_ARCH_WANTS_STACK_ALIGNMENT).
735 // Henceforth, only EIGEN_MAX_STATIC_ALIGN_BYTES should be used.
736 
737 
738 // Shortcuts to EIGEN_ALIGN_TO_BOUNDARY
739 #define EIGEN_ALIGN8 EIGEN_ALIGN_TO_BOUNDARY(8)
740 #define EIGEN_ALIGN16 EIGEN_ALIGN_TO_BOUNDARY(16)
741 #define EIGEN_ALIGN32 EIGEN_ALIGN_TO_BOUNDARY(32)
742 #define EIGEN_ALIGN64 EIGEN_ALIGN_TO_BOUNDARY(64)
743 #if EIGEN_MAX_STATIC_ALIGN_BYTES>0
744 #define EIGEN_ALIGN_MAX EIGEN_ALIGN_TO_BOUNDARY(EIGEN_MAX_STATIC_ALIGN_BYTES)
745 #else
746 #define EIGEN_ALIGN_MAX
747 #endif
748 
749 
750 // Dynamic alignment control
751 
752 #if defined(EIGEN_DONT_ALIGN) && defined(EIGEN_MAX_ALIGN_BYTES) && EIGEN_MAX_ALIGN_BYTES>0
753 #error EIGEN_MAX_ALIGN_BYTES and EIGEN_DONT_ALIGN are both defined with EIGEN_MAX_ALIGN_BYTES!=0. Use EIGEN_MAX_ALIGN_BYTES=0 as a synonym of EIGEN_DONT_ALIGN.
754 #endif
755 
756 #ifdef EIGEN_DONT_ALIGN
757  #ifdef EIGEN_MAX_ALIGN_BYTES
758  #undef EIGEN_MAX_ALIGN_BYTES
759  #endif
760  #define EIGEN_MAX_ALIGN_BYTES 0
761 #elif !defined(EIGEN_MAX_ALIGN_BYTES)
762  #define EIGEN_MAX_ALIGN_BYTES EIGEN_IDEAL_MAX_ALIGN_BYTES
763 #endif
764 
765 #if EIGEN_IDEAL_MAX_ALIGN_BYTES > EIGEN_MAX_ALIGN_BYTES
766 #define EIGEN_DEFAULT_ALIGN_BYTES EIGEN_IDEAL_MAX_ALIGN_BYTES
767 #else
768 #define EIGEN_DEFAULT_ALIGN_BYTES EIGEN_MAX_ALIGN_BYTES
769 #endif
770 
771 
772 #ifndef EIGEN_UNALIGNED_VECTORIZE
773 #define EIGEN_UNALIGNED_VECTORIZE 1
774 #endif
775 
776 //----------------------------------------------------------------------
777 
778 
779 #ifdef EIGEN_DONT_USE_RESTRICT_KEYWORD
780  #define EIGEN_RESTRICT
781 #endif
782 #ifndef EIGEN_RESTRICT
783  #define EIGEN_RESTRICT __restrict
784 #endif
785 
786 #ifndef EIGEN_STACK_ALLOCATION_LIMIT
787 // 131072 == 128 KB
788 #define EIGEN_STACK_ALLOCATION_LIMIT 131072
789 #endif
790 
791 #ifndef EIGEN_DEFAULT_IO_FORMAT
792 #ifdef EIGEN_MAKING_DOCS
793 // format used in Eigen's documentation
794 // needed to define it here as escaping characters in CMake add_definition's argument seems very problematic.
795 #define EIGEN_DEFAULT_IO_FORMAT Eigen::IOFormat(3, 0, " ", "\n", "", "")
796 #else
797 #define EIGEN_DEFAULT_IO_FORMAT Eigen::IOFormat()
798 #endif
799 #endif
800 
801 // just an empty macro !
802 #define EIGEN_EMPTY
803 
804 #if EIGEN_COMP_MSVC_STRICT && EIGEN_COMP_MSVC < 1900 // for older MSVC versions using the base operator is sufficient (cf Bug 1000)
805  #define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived) \
806  using Base::operator =;
807 #elif EIGEN_COMP_CLANG // workaround clang bug (see http://forum.kde.org/viewtopic.php?f=74&t=102653)
808  #define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived) \
809  using Base::operator =; \
810  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& operator=(const Derived& other) { Base::operator=(other); return *this; } \
811  template <typename OtherDerived> \
812  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& operator=(const DenseBase<OtherDerived>& other) { Base::operator=(other.derived()); return *this; }
813 #else
814  #define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived) \
815  using Base::operator =; \
816  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& operator=(const Derived& other) \
817  { \
818  Base::operator=(other); \
819  return *this; \
820  }
821 #endif
822 
823 
828 #define EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Derived) EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived)
829 
838 #define EIGEN_GENERIC_PUBLIC_INTERFACE(Derived) \
839  typedef typename Eigen::internal::traits<Derived>::Scalar Scalar; \
840  typedef typename Eigen::NumTraits<Scalar>::Real RealScalar; \
841  typedef typename Base::CoeffReturnType CoeffReturnType; \
842  typedef typename Eigen::internal::ref_selector<Derived>::type Nested; \
843  typedef typename Eigen::internal::traits<Derived>::StorageKind StorageKind; \
844  typedef typename Eigen::internal::traits<Derived>::StorageIndex StorageIndex; \
845  enum { RowsAtCompileTime = Eigen::internal::traits<Derived>::RowsAtCompileTime, \
846  ColsAtCompileTime = Eigen::internal::traits<Derived>::ColsAtCompileTime, \
847  Flags = Eigen::internal::traits<Derived>::Flags, \
848  SizeAtCompileTime = Base::SizeAtCompileTime, \
849  MaxSizeAtCompileTime = Base::MaxSizeAtCompileTime, \
850  IsVectorAtCompileTime = Base::IsVectorAtCompileTime }; \
851  using Base::derived; \
852  using Base::const_cast_derived;
853 
854 
855 // FIXME Maybe the EIGEN_DENSE_PUBLIC_INTERFACE could be removed as importing PacketScalar is rarely needed
856 #define EIGEN_DENSE_PUBLIC_INTERFACE(Derived) \
857  EIGEN_GENERIC_PUBLIC_INTERFACE(Derived) \
858  typedef typename Base::PacketScalar PacketScalar;
859 
860 
861 #define EIGEN_PLAIN_ENUM_MIN(a,b) (((int)a <= (int)b) ? (int)a : (int)b)
862 #define EIGEN_PLAIN_ENUM_MAX(a,b) (((int)a >= (int)b) ? (int)a : (int)b)
863 
864 // EIGEN_SIZE_MIN_PREFER_DYNAMIC gives the min between compile-time sizes. 0 has absolute priority, followed by 1,
865 // followed by Dynamic, followed by other finite values. The reason for giving Dynamic the priority over
866 // finite values is that min(3, Dynamic) should be Dynamic, since that could be anything between 0 and 3.
867 #define EIGEN_SIZE_MIN_PREFER_DYNAMIC(a,b) (((int)a == 0 || (int)b == 0) ? 0 \
868  : ((int)a == 1 || (int)b == 1) ? 1 \
869  : ((int)a == Dynamic || (int)b == Dynamic) ? Dynamic \
870  : ((int)a <= (int)b) ? (int)a : (int)b)
871 
872 // EIGEN_SIZE_MIN_PREFER_FIXED is a variant of EIGEN_SIZE_MIN_PREFER_DYNAMIC comparing MaxSizes. The difference is that finite values
873 // now have priority over Dynamic, so that min(3, Dynamic) gives 3. Indeed, whatever the actual value is
874 // (between 0 and 3), it is not more than 3.
875 #define EIGEN_SIZE_MIN_PREFER_FIXED(a,b) (((int)a == 0 || (int)b == 0) ? 0 \
876  : ((int)a == 1 || (int)b == 1) ? 1 \
877  : ((int)a == Dynamic && (int)b == Dynamic) ? Dynamic \
878  : ((int)a == Dynamic) ? (int)b \
879  : ((int)b == Dynamic) ? (int)a \
880  : ((int)a <= (int)b) ? (int)a : (int)b)
881 
882 // see EIGEN_SIZE_MIN_PREFER_DYNAMIC. No need for a separate variant for MaxSizes here.
883 #define EIGEN_SIZE_MAX(a,b) (((int)a == Dynamic || (int)b == Dynamic) ? Dynamic \
884  : ((int)a >= (int)b) ? (int)a : (int)b)
885 
886 #define EIGEN_LOGICAL_XOR(a,b) (((a) || (b)) && !((a) && (b)))
887 
888 #define EIGEN_IMPLIES(a,b) (!(a) || (b))
889 
890 // the expression type of a standard coefficient wise binary operation
891 #define EIGEN_CWISE_BINARY_RETURN_TYPE(LHS,RHS,OPNAME) \
892  CwiseBinaryOp< \
893  EIGEN_CAT(EIGEN_CAT(internal::scalar_,OPNAME),_op)< \
894  typename internal::traits<LHS>::Scalar, \
895  typename internal::traits<RHS>::Scalar \
896  >, \
897  const LHS, \
898  const RHS \
899  >
900 
901 #define EIGEN_MAKE_CWISE_BINARY_OP(METHOD,OPNAME) \
902  template<typename OtherDerived> \
903  EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const EIGEN_CWISE_BINARY_RETURN_TYPE(Derived,OtherDerived,OPNAME) \
904  (METHOD)(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const \
905  { \
906  return EIGEN_CWISE_BINARY_RETURN_TYPE(Derived,OtherDerived,OPNAME)(derived(), other.derived()); \
907  }
908 
909 #define EIGEN_SCALAR_BINARY_SUPPORTED(OPNAME,TYPEA,TYPEB) \
910  (Eigen::internal::has_ReturnType<Eigen::ScalarBinaryOpTraits<TYPEA,TYPEB,EIGEN_CAT(EIGEN_CAT(Eigen::internal::scalar_,OPNAME),_op)<TYPEA,TYPEB> > >::value)
911 
912 #define EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(EXPR,SCALAR,OPNAME) \
913  CwiseBinaryOp<EIGEN_CAT(EIGEN_CAT(internal::scalar_,OPNAME),_op)<typename internal::traits<EXPR>::Scalar,SCALAR>, const EXPR, \
914  const typename internal::plain_constant_type<EXPR,SCALAR>::type>
915 
916 #define EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(SCALAR,EXPR,OPNAME) \
917  CwiseBinaryOp<EIGEN_CAT(EIGEN_CAT(internal::scalar_,OPNAME),_op)<SCALAR,typename internal::traits<EXPR>::Scalar>, \
918  const typename internal::plain_constant_type<EXPR,SCALAR>::type, const EXPR>
919 
920 // Workaround for MSVC 2010 (see ML thread "patch with compile for for MSVC 2010")
921 #if EIGEN_COMP_MSVC_STRICT<=1600
922 #define EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(X) typename internal::enable_if<true,X>::type
923 #else
924 #define EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(X) X
925 #endif
926 
927 #define EIGEN_MAKE_SCALAR_BINARY_OP_ONTHERIGHT(METHOD,OPNAME) \
928  template <typename T> EIGEN_DEVICE_FUNC inline \
929  EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(Derived,typename internal::promote_scalar_arg<Scalar EIGEN_COMMA T EIGEN_COMMA EIGEN_SCALAR_BINARY_SUPPORTED(OPNAME,Scalar,T)>::type,OPNAME))\
930  (METHOD)(const T& scalar) const { \
931  typedef typename internal::promote_scalar_arg<Scalar,T,EIGEN_SCALAR_BINARY_SUPPORTED(OPNAME,Scalar,T)>::type PromotedT; \
932  return EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(Derived,PromotedT,OPNAME)(derived(), \
933  typename internal::plain_constant_type<Derived,PromotedT>::type(derived().rows(), derived().cols(), internal::scalar_constant_op<PromotedT>(scalar))); \
934  }
935 
936 #define EIGEN_MAKE_SCALAR_BINARY_OP_ONTHELEFT(METHOD,OPNAME) \
937  template <typename T> EIGEN_DEVICE_FUNC inline friend \
938  EIGEN_MSVC10_WORKAROUND_BINARYOP_RETURN_TYPE(const EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(typename internal::promote_scalar_arg<Scalar EIGEN_COMMA T EIGEN_COMMA EIGEN_SCALAR_BINARY_SUPPORTED(OPNAME,T,Scalar)>::type,Derived,OPNAME)) \
939  (METHOD)(const T& scalar, const StorageBaseType& matrix) { \
940  typedef typename internal::promote_scalar_arg<Scalar,T,EIGEN_SCALAR_BINARY_SUPPORTED(OPNAME,T,Scalar)>::type PromotedT; \
941  return EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE(PromotedT,Derived,OPNAME)( \
942  typename internal::plain_constant_type<Derived,PromotedT>::type(matrix.derived().rows(), matrix.derived().cols(), internal::scalar_constant_op<PromotedT>(scalar)), matrix.derived()); \
943  }
944 
945 #define EIGEN_MAKE_SCALAR_BINARY_OP(METHOD,OPNAME) \
946  EIGEN_MAKE_SCALAR_BINARY_OP_ONTHELEFT(METHOD,OPNAME) \
947  EIGEN_MAKE_SCALAR_BINARY_OP_ONTHERIGHT(METHOD,OPNAME)
948 
949 
950 #ifdef EIGEN_EXCEPTIONS
951 # define EIGEN_THROW_X(X) throw X
952 # define EIGEN_THROW throw
953 # define EIGEN_TRY try
954 # define EIGEN_CATCH(X) catch (X)
955 #else
956 # ifdef __CUDA_ARCH__
957 # define EIGEN_THROW_X(X) asm("trap;") return {}
958 # define EIGEN_THROW asm("trap;"); return {}
959 # else
960 # define EIGEN_THROW_X(X) std::abort()
961 # define EIGEN_THROW std::abort()
962 # endif
963 # define EIGEN_TRY if (true)
964 # define EIGEN_CATCH(X) else
965 #endif
966 
967 
968 #if EIGEN_HAS_CXX11_NOEXCEPT
969 # define EIGEN_INCLUDE_TYPE_TRAITS
970 # define EIGEN_NOEXCEPT noexcept
971 # define EIGEN_NOEXCEPT_IF(x) noexcept(x)
972 # define EIGEN_NO_THROW noexcept(true)
973 # define EIGEN_EXCEPTION_SPEC(X) noexcept(false)
974 #else
975 # define EIGEN_NOEXCEPT
976 # define EIGEN_NOEXCEPT_IF(x)
977 # define EIGEN_NO_THROW throw()
978 # define EIGEN_EXCEPTION_SPEC(X) throw(X)
979 #endif
980 
981 #endif // EIGEN_MACROS_H
Namespace containing all symbols from the Eigen library.
Definition: Core:271
Definition: Eigen_Colamd.h:50