1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008-2010 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 1
16#define EIGEN_MINOR_VERSION 1
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#ifdef __GNUC__
22  #define EIGEN_GNUC_AT_LEAST(x,y) ((__GNUC__==x && __GNUC_MINOR__>=y) || __GNUC__>x)
23#else
24  #define EIGEN_GNUC_AT_LEAST(x,y) 0
25#endif
26
27#ifdef __GNUC__
28  #define EIGEN_GNUC_AT_MOST(x,y) ((__GNUC__==x && __GNUC_MINOR__<=y) || __GNUC__<x)
29#else
30  #define EIGEN_GNUC_AT_MOST(x,y) 0
31#endif
32
33#if EIGEN_GNUC_AT_MOST(4,3) && !defined(__clang__)
34  // see bug 89
35  #define EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO 0
36#else
37  #define EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO 1
38#endif
39
40#if defined(__GNUC__) && (__GNUC__ <= 3)
41#define EIGEN_GCC3_OR_OLDER 1
42#else
43#define EIGEN_GCC3_OR_OLDER 0
44#endif
45
46// 16 byte alignment is only useful for vectorization. Since it affects the ABI, we need to enable
47// 16 byte alignment on all platforms where vectorization might be enabled. In theory we could always
48// enable alignment, but it can be a cause of problems on some platforms, so we just disable it in
49// certain common platform (compiler+architecture combinations) to avoid these problems.
50// Only static alignment is really problematic (relies on nonstandard compiler extensions that don't
51// work everywhere, for example don't work on GCC/ARM), try to keep heap alignment even
52// when we have to disable static alignment.
53#if defined(__GNUC__) && !(defined(__i386__) || defined(__x86_64__) || defined(__powerpc__) || defined(__ppc__) || defined(__ia64__))
54#define EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT 1
55#else
56#define EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT 0
57#endif
58
59// static alignment is completely disabled with GCC 3, Sun Studio, and QCC/QNX
60#if !EIGEN_GCC_AND_ARCH_DOESNT_WANT_STACK_ALIGNMENT \
61 && !EIGEN_GCC3_OR_OLDER \
62 && !defined(__SUNPRO_CC) \
63 && !defined(__QNXNTO__)
64  #define EIGEN_ARCH_WANTS_STACK_ALIGNMENT 1
65#else
66  #define EIGEN_ARCH_WANTS_STACK_ALIGNMENT 0
67#endif
68
69#ifdef EIGEN_DONT_ALIGN
70  #ifndef EIGEN_DONT_ALIGN_STATICALLY
71    #define EIGEN_DONT_ALIGN_STATICALLY
72  #endif
73  #define EIGEN_ALIGN 0
74#else
75  #define EIGEN_ALIGN 1
76#endif
77
78// EIGEN_ALIGN_STATICALLY is the true test whether we want to align arrays on the stack or not. It takes into account both the user choice to explicitly disable
79// alignment (EIGEN_DONT_ALIGN_STATICALLY) and the architecture config (EIGEN_ARCH_WANTS_STACK_ALIGNMENT). Henceforth, only EIGEN_ALIGN_STATICALLY should be used.
80#if EIGEN_ARCH_WANTS_STACK_ALIGNMENT && !defined(EIGEN_DONT_ALIGN_STATICALLY)
81  #define EIGEN_ALIGN_STATICALLY 1
82#else
83  #define EIGEN_ALIGN_STATICALLY 0
84  #ifndef EIGEN_DISABLE_UNALIGNED_ARRAY_ASSERT
85    #define EIGEN_DISABLE_UNALIGNED_ARRAY_ASSERT
86  #endif
87#endif
88
89#ifdef EIGEN_DEFAULT_TO_ROW_MAJOR
90#define EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION RowMajor
91#else
92#define EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION ColMajor
93#endif
94
95#ifndef EIGEN_DEFAULT_DENSE_INDEX_TYPE
96#define EIGEN_DEFAULT_DENSE_INDEX_TYPE std::ptrdiff_t
97#endif
98
99/** Allows to disable some optimizations which might affect the accuracy of the result.
100  * Such optimization are enabled by default, and set EIGEN_FAST_MATH to 0 to disable them.
101  * They currently include:
102  *   - single precision Cwise::sin() and Cwise::cos() when SSE vectorization is enabled.
103  */
104#ifndef EIGEN_FAST_MATH
105#define EIGEN_FAST_MATH 1
106#endif
107
108#define EIGEN_DEBUG_VAR(x) std::cerr << #x << " = " << x << std::endl;
109
110// concatenate two tokens
111#define EIGEN_CAT2(a,b) a ## b
112#define EIGEN_CAT(a,b) EIGEN_CAT2(a,b)
113
114// convert a token to a string
115#define EIGEN_MAKESTRING2(a) #a
116#define EIGEN_MAKESTRING(a) EIGEN_MAKESTRING2(a)
117
118#if EIGEN_GNUC_AT_LEAST(4,1) && !defined(__clang__) && !defined(__INTEL_COMPILER)
119#define EIGEN_FLATTEN_ATTRIB __attribute__((flatten))
120#else
121#define EIGEN_FLATTEN_ATTRIB
122#endif
123
124// EIGEN_STRONG_INLINE is a stronger version of the inline, using __forceinline on MSVC,
125// but it still doesn't use GCC's always_inline. This is useful in (common) situations where MSVC needs forceinline
126// but GCC is still doing fine with just inline.
127#if (defined _MSC_VER) || (defined __INTEL_COMPILER)
128#define EIGEN_STRONG_INLINE __forceinline
129#else
130#define EIGEN_STRONG_INLINE inline
131#endif
132
133// EIGEN_ALWAYS_INLINE is the stronget, it has the effect of making the function inline and adding every possible
134// attribute to maximize inlining. This should only be used when really necessary: in particular,
135// it uses __attribute__((always_inline)) on GCC, which most of the time is useless and can severely harm compile times.
136// FIXME with the always_inline attribute,
137// gcc 3.4.x reports the following compilation error:
138//   Eval.h:91: sorry, unimplemented: inlining failed in call to 'const Eigen::Eval<Derived> Eigen::MatrixBase<Scalar, Derived>::eval() const'
139//    : function body not available
140#if EIGEN_GNUC_AT_LEAST(4,0)
141#define EIGEN_ALWAYS_INLINE __attribute__((always_inline)) inline
142#else
143#define EIGEN_ALWAYS_INLINE EIGEN_STRONG_INLINE
144#endif
145
146#if (defined __GNUC__)
147#define EIGEN_DONT_INLINE __attribute__((noinline))
148#elif (defined _MSC_VER)
149#define EIGEN_DONT_INLINE __declspec(noinline)
150#else
151#define EIGEN_DONT_INLINE
152#endif
153
154// this macro allows to get rid of linking errors about multiply defined functions.
155//  - static is not very good because it prevents definitions from different object files to be merged.
156//           So static causes the resulting linked executable to be bloated with multiple copies of the same function.
157//  - inline is not perfect either as it unwantedly hints the compiler toward inlining the function.
158#define EIGEN_DECLARE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS
159#define EIGEN_DEFINE_FUNCTION_ALLOWING_MULTIPLE_DEFINITIONS inline
160
161#ifdef NDEBUG
162# ifndef EIGEN_NO_DEBUG
163#  define EIGEN_NO_DEBUG
164# endif
165#endif
166
167// eigen_plain_assert is where we implement the workaround for the assert() bug in GCC <= 4.3, see bug 89
168#ifdef EIGEN_NO_DEBUG
169  #define eigen_plain_assert(x)
170#else
171  #if EIGEN_SAFE_TO_USE_STANDARD_ASSERT_MACRO
172    namespace Eigen {
173    namespace internal {
174    inline bool copy_bool(bool b) { return b; }
175    }
176    }
177    #define eigen_plain_assert(x) assert(x)
178  #else
179    // work around bug 89
180    #include <cstdlib>   // for abort
181    #include <iostream>  // for std::cerr
182
183    namespace Eigen {
184    namespace internal {
185    // trivial function copying a bool. Must be EIGEN_DONT_INLINE, so we implement it after including Eigen headers.
186    // see bug 89.
187    namespace {
188    EIGEN_DONT_INLINE bool copy_bool(bool b) { return b; }
189    }
190    inline void assert_fail(const char *condition, const char *function, const char *file, int line)
191    {
192      std::cerr << "assertion failed: " << condition << " in function " << function << " at " << file << ":" << line << std::endl;
193      abort();
194    }
195    }
196    }
197    #define eigen_plain_assert(x) \
198      do { \
199        if(!Eigen::internal::copy_bool(x)) \
200          Eigen::internal::assert_fail(EIGEN_MAKESTRING(x), __PRETTY_FUNCTION__, __FILE__, __LINE__); \
201      } while(false)
202  #endif
203#endif
204
205// eigen_assert can be overridden
206#ifndef eigen_assert
207#define eigen_assert(x) eigen_plain_assert(x)
208#endif
209
210#ifdef EIGEN_INTERNAL_DEBUGGING
211#define eigen_internal_assert(x) eigen_assert(x)
212#else
213#define eigen_internal_assert(x)
214#endif
215
216#ifdef EIGEN_NO_DEBUG
217#define EIGEN_ONLY_USED_FOR_DEBUG(x) (void)x
218#else
219#define EIGEN_ONLY_USED_FOR_DEBUG(x)
220#endif
221
222#ifndef EIGEN_NO_DEPRECATED_WARNING
223  #if (defined __GNUC__)
224    #define EIGEN_DEPRECATED __attribute__((deprecated))
225  #elif (defined _MSC_VER)
226    #define EIGEN_DEPRECATED __declspec(deprecated)
227  #else
228    #define EIGEN_DEPRECATED
229  #endif
230#else
231  #define EIGEN_DEPRECATED
232#endif
233
234#if (defined __GNUC__)
235#define EIGEN_UNUSED __attribute__((unused))
236#else
237#define EIGEN_UNUSED
238#endif
239
240// Suppresses 'unused variable' warnings.
241#define EIGEN_UNUSED_VARIABLE(var) (void)var;
242
243#if !defined(EIGEN_ASM_COMMENT) && (defined __GNUC__)
244#define EIGEN_ASM_COMMENT(X)  asm("#" X)
245#else
246#define EIGEN_ASM_COMMENT(X)
247#endif
248
249/* EIGEN_ALIGN_TO_BOUNDARY(n) forces data to be n-byte aligned. This is used to satisfy SIMD requirements.
250 * However, we do that EVEN if vectorization (EIGEN_VECTORIZE) is disabled,
251 * so that vectorization doesn't affect binary compatibility.
252 *
253 * If we made alignment depend on whether or not EIGEN_VECTORIZE is defined, it would be impossible to link
254 * vectorized and non-vectorized code.
255 */
256#if (defined __GNUC__) || (defined __PGI) || (defined __IBMCPP__) || (defined __ARMCC_VERSION)
257  #define EIGEN_ALIGN_TO_BOUNDARY(n) __attribute__((aligned(n)))
258#elif (defined _MSC_VER)
259  #define EIGEN_ALIGN_TO_BOUNDARY(n) __declspec(align(n))
260#elif (defined __SUNPRO_CC)
261  // FIXME not sure about this one:
262  #define EIGEN_ALIGN_TO_BOUNDARY(n) __attribute__((aligned(n)))
263#else
264  #error Please tell me what is the equivalent of __attribute__((aligned(n))) for your compiler
265#endif
266
267#define EIGEN_ALIGN16 EIGEN_ALIGN_TO_BOUNDARY(16)
268
269#if EIGEN_ALIGN_STATICALLY
270#define EIGEN_USER_ALIGN_TO_BOUNDARY(n) EIGEN_ALIGN_TO_BOUNDARY(n)
271#define EIGEN_USER_ALIGN16 EIGEN_ALIGN16
272#else
273#define EIGEN_USER_ALIGN_TO_BOUNDARY(n)
274#define EIGEN_USER_ALIGN16
275#endif
276
277#ifdef EIGEN_DONT_USE_RESTRICT_KEYWORD
278  #define EIGEN_RESTRICT
279#endif
280#ifndef EIGEN_RESTRICT
281  #define EIGEN_RESTRICT __restrict
282#endif
283
284#ifndef EIGEN_STACK_ALLOCATION_LIMIT
285#define EIGEN_STACK_ALLOCATION_LIMIT 20000
286#endif
287
288#ifndef EIGEN_DEFAULT_IO_FORMAT
289#ifdef EIGEN_MAKING_DOCS
290// format used in Eigen's documentation
291// needed to define it here as escaping characters in CMake add_definition's argument seems very problematic.
292#define EIGEN_DEFAULT_IO_FORMAT Eigen::IOFormat(3, 0, " ", "\n", "", "")
293#else
294#define EIGEN_DEFAULT_IO_FORMAT Eigen::IOFormat()
295#endif
296#endif
297
298// just an empty macro !
299#define EIGEN_EMPTY
300
301#if defined(_MSC_VER) && (!defined(__INTEL_COMPILER))
302#define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived) \
303  using Base::operator =;
304#else
305#define EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived) \
306  using Base::operator =; \
307  EIGEN_STRONG_INLINE Derived& operator=(const Derived& other) \
308  { \
309    Base::operator=(other); \
310    return *this; \
311  }
312#endif
313
314#define EIGEN_INHERIT_ASSIGNMENT_OPERATORS(Derived) \
315  EIGEN_INHERIT_ASSIGNMENT_EQUAL_OPERATOR(Derived)
316
317/**
318* Just a side note. Commenting within defines works only by documenting
319* behind the object (via '!<'). Comments cannot be multi-line and thus
320* we have these extra long lines. What is confusing doxygen over here is
321* that we use '\' and basically have a bunch of typedefs with their
322* documentation in a single line.
323**/
324
325#define EIGEN_GENERIC_PUBLIC_INTERFACE(Derived) \
326  typedef typename Eigen::internal::traits<Derived>::Scalar Scalar; /*!< \brief Numeric type, e.g. float, double, int or std::complex<float>. */ \
327  typedef typename Eigen::NumTraits<Scalar>::Real RealScalar; /*!< \brief The underlying numeric type for composed scalar types. \details In cases where Scalar is e.g. std::complex<T>, T were corresponding to RealScalar. */ \
328  typedef typename Base::CoeffReturnType CoeffReturnType; /*!< \brief The return type for coefficient access. \details Depending on whether the object allows direct coefficient access (e.g. for a MatrixXd), this type is either 'const Scalar&' or simply 'Scalar' for objects that do not allow direct coefficient access. */ \
329  typedef typename Eigen::internal::nested<Derived>::type Nested; \
330  typedef typename Eigen::internal::traits<Derived>::StorageKind StorageKind; \
331  typedef typename Eigen::internal::traits<Derived>::Index Index; \
332  enum { RowsAtCompileTime = Eigen::internal::traits<Derived>::RowsAtCompileTime, \
333        ColsAtCompileTime = Eigen::internal::traits<Derived>::ColsAtCompileTime, \
334        Flags = Eigen::internal::traits<Derived>::Flags, \
335        CoeffReadCost = Eigen::internal::traits<Derived>::CoeffReadCost, \
336        SizeAtCompileTime = Base::SizeAtCompileTime, \
337        MaxSizeAtCompileTime = Base::MaxSizeAtCompileTime, \
338        IsVectorAtCompileTime = Base::IsVectorAtCompileTime };
339
340
341#define EIGEN_DENSE_PUBLIC_INTERFACE(Derived) \
342  typedef typename Eigen::internal::traits<Derived>::Scalar Scalar; /*!< \brief Numeric type, e.g. float, double, int or std::complex<float>. */ \
343  typedef typename Eigen::NumTraits<Scalar>::Real RealScalar; /*!< \brief The underlying numeric type for composed scalar types. \details In cases where Scalar is e.g. std::complex<T>, T were corresponding to RealScalar. */ \
344  typedef typename Base::PacketScalar PacketScalar; \
345  typedef typename Base::CoeffReturnType CoeffReturnType; /*!< \brief The return type for coefficient access. \details Depending on whether the object allows direct coefficient access (e.g. for a MatrixXd), this type is either 'const Scalar&' or simply 'Scalar' for objects that do not allow direct coefficient access. */ \
346  typedef typename Eigen::internal::nested<Derived>::type Nested; \
347  typedef typename Eigen::internal::traits<Derived>::StorageKind StorageKind; \
348  typedef typename Eigen::internal::traits<Derived>::Index Index; \
349  enum { RowsAtCompileTime = Eigen::internal::traits<Derived>::RowsAtCompileTime, \
350        ColsAtCompileTime = Eigen::internal::traits<Derived>::ColsAtCompileTime, \
351        MaxRowsAtCompileTime = Eigen::internal::traits<Derived>::MaxRowsAtCompileTime, \
352        MaxColsAtCompileTime = Eigen::internal::traits<Derived>::MaxColsAtCompileTime, \
353        Flags = Eigen::internal::traits<Derived>::Flags, \
354        CoeffReadCost = Eigen::internal::traits<Derived>::CoeffReadCost, \
355        SizeAtCompileTime = Base::SizeAtCompileTime, \
356        MaxSizeAtCompileTime = Base::MaxSizeAtCompileTime, \
357        IsVectorAtCompileTime = Base::IsVectorAtCompileTime }; \
358  using Base::derived; \
359  using Base::const_cast_derived;
360
361
362#define EIGEN_PLAIN_ENUM_MIN(a,b) (((int)a <= (int)b) ? (int)a : (int)b)
363#define EIGEN_PLAIN_ENUM_MAX(a,b) (((int)a >= (int)b) ? (int)a : (int)b)
364
365// EIGEN_SIZE_MIN_PREFER_DYNAMIC gives the min between compile-time sizes. 0 has absolute priority, followed by 1,
366// followed by Dynamic, followed by other finite values. The reason for giving Dynamic the priority over
367// finite values is that min(3, Dynamic) should be Dynamic, since that could be anything between 0 and 3.
368#define EIGEN_SIZE_MIN_PREFER_DYNAMIC(a,b) (((int)a == 0 || (int)b == 0) ? 0 \
369                           : ((int)a == 1 || (int)b == 1) ? 1 \
370                           : ((int)a == Dynamic || (int)b == Dynamic) ? Dynamic \
371                           : ((int)a <= (int)b) ? (int)a : (int)b)
372
373// EIGEN_SIZE_MIN_PREFER_FIXED is a variant of EIGEN_SIZE_MIN_PREFER_DYNAMIC comparing MaxSizes. The difference is that finite values
374// now have priority over Dynamic, so that min(3, Dynamic) gives 3. Indeed, whatever the actual value is
375// (between 0 and 3), it is not more than 3.
376#define EIGEN_SIZE_MIN_PREFER_FIXED(a,b)  (((int)a == 0 || (int)b == 0) ? 0 \
377                           : ((int)a == 1 || (int)b == 1) ? 1 \
378                           : ((int)a == Dynamic && (int)b == Dynamic) ? Dynamic \
379                           : ((int)a == Dynamic) ? (int)b \
380                           : ((int)b == Dynamic) ? (int)a \
381                           : ((int)a <= (int)b) ? (int)a : (int)b)
382
383// see EIGEN_SIZE_MIN_PREFER_DYNAMIC. No need for a separate variant for MaxSizes here.
384#define EIGEN_SIZE_MAX(a,b) (((int)a == Dynamic || (int)b == Dynamic) ? Dynamic \
385                           : ((int)a >= (int)b) ? (int)a : (int)b)
386
387#define EIGEN_LOGICAL_XOR(a,b) (((a) || (b)) && !((a) && (b)))
388
389#define EIGEN_IMPLIES(a,b) (!(a) || (b))
390
391#define EIGEN_MAKE_CWISE_BINARY_OP(METHOD,FUNCTOR) \
392  template<typename OtherDerived> \
393  EIGEN_STRONG_INLINE const CwiseBinaryOp<FUNCTOR<Scalar>, const Derived, const OtherDerived> \
394  (METHOD)(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const \
395  { \
396    return CwiseBinaryOp<FUNCTOR<Scalar>, const Derived, const OtherDerived>(derived(), other.derived()); \
397  }
398
399// the expression type of a cwise product
400#define EIGEN_CWISE_PRODUCT_RETURN_TYPE(LHS,RHS) \
401    CwiseBinaryOp< \
402      internal::scalar_product_op< \
403          typename internal::traits<LHS>::Scalar, \
404          typename internal::traits<RHS>::Scalar \
405      >, \
406      const LHS, \
407      const RHS \
408    >
409
410#endif // EIGEN_MACROS_H
411