Another set of UI messages fixes and tweaks! No functional changes.
[blender.git] / extern / Eigen3 / Eigen / Core
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
5 // Copyright (C) 2007-2011 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_CORE_H
27 #define EIGEN_CORE_H
28
29 // first thing Eigen does: stop the compiler from committing suicide
30 #include "src/Core/util/DisableStupidWarnings.h"
31
32 // then include this file where all our macros are defined. It's really important to do it first because
33 // it's where we do all the alignment settings (platform detection and honoring the user's will if he
34 // defined e.g. EIGEN_DONT_ALIGN) so it needs to be done before we do anything with vectorization.
35 #include "src/Core/util/Macros.h"
36
37 // if alignment is disabled, then disable vectorization. Note: EIGEN_ALIGN is the proper check, it takes into
38 // account both the user's will (EIGEN_DONT_ALIGN) and our own platform checks
39 #if !EIGEN_ALIGN
40   #ifndef EIGEN_DONT_VECTORIZE
41     #define EIGEN_DONT_VECTORIZE
42   #endif
43 #endif
44
45 #ifdef _MSC_VER
46   #include <malloc.h> // for _aligned_malloc -- need it regardless of whether vectorization is enabled
47   #if (_MSC_VER >= 1500) // 2008 or later
48     // Remember that usage of defined() in a #define is undefined by the standard.
49     // a user reported that in 64-bit mode, MSVC doesn't care to define _M_IX86_FP.
50     #if (defined(_M_IX86_FP) && (_M_IX86_FP >= 2)) || defined(_M_X64)
51       #define EIGEN_SSE2_ON_MSVC_2008_OR_LATER
52     #endif
53   #endif
54 #else
55   // Remember that usage of defined() in a #define is undefined by the standard
56   #if (defined __SSE2__) && ( (!defined __GNUC__) || EIGEN_GNUC_AT_LEAST(4,2) )
57     #define EIGEN_SSE2_ON_NON_MSVC_BUT_NOT_OLD_GCC
58   #endif
59 #endif
60
61 #ifndef EIGEN_DONT_VECTORIZE
62
63   #if defined (EIGEN_SSE2_ON_NON_MSVC_BUT_NOT_OLD_GCC) || defined(EIGEN_SSE2_ON_MSVC_2008_OR_LATER)
64
65     // Defines symbols for compile-time detection of which instructions are
66     // used.
67     // EIGEN_VECTORIZE_YY is defined if and only if the instruction set YY is used
68     #define EIGEN_VECTORIZE
69     #define EIGEN_VECTORIZE_SSE
70     #define EIGEN_VECTORIZE_SSE2
71
72     // Detect sse3/ssse3/sse4:
73     // gcc and icc defines __SSE3__, ...
74     // there is no way to know about this on msvc. You can define EIGEN_VECTORIZE_SSE* if you
75     // want to force the use of those instructions with msvc.
76     #ifdef __SSE3__
77       #define EIGEN_VECTORIZE_SSE3
78     #endif
79     #ifdef __SSSE3__
80       #define EIGEN_VECTORIZE_SSSE3
81     #endif
82     #ifdef __SSE4_1__
83       #define EIGEN_VECTORIZE_SSE4_1
84     #endif
85     #ifdef __SSE4_2__
86       #define EIGEN_VECTORIZE_SSE4_2
87     #endif
88
89     // include files
90
91     // This extern "C" works around a MINGW-w64 compilation issue
92     // https://sourceforge.net/tracker/index.php?func=detail&aid=3018394&group_id=202880&atid=983354
93     // In essence, intrin.h is included by windows.h and also declares intrinsics (just as emmintrin.h etc. below do).
94     // However, intrin.h uses an extern "C" declaration, and g++ thus complains of duplicate declarations
95     // with conflicting linkage.  The linkage for intrinsics doesn't matter, but at that stage the compiler doesn't know;
96     // so, to avoid compile errors when windows.h is included after Eigen/Core, ensure intrinsics are extern "C" here too.
97     // notice that since these are C headers, the extern "C" is theoretically needed anyways.
98     extern "C" {
99       #include <emmintrin.h>
100       #include <xmmintrin.h>
101       #ifdef  EIGEN_VECTORIZE_SSE3
102       #include <pmmintrin.h>
103       #endif
104       #ifdef EIGEN_VECTORIZE_SSSE3
105       #include <tmmintrin.h>
106       #endif
107       #ifdef EIGEN_VECTORIZE_SSE4_1
108       #include <smmintrin.h>
109       #endif
110       #ifdef EIGEN_VECTORIZE_SSE4_2
111       #include <nmmintrin.h>
112       #endif
113     } // end extern "C"
114   #elif defined __ALTIVEC__
115     #define EIGEN_VECTORIZE
116     #define EIGEN_VECTORIZE_ALTIVEC
117     #include <altivec.h>
118     // We need to #undef all these ugly tokens defined in <altivec.h>
119     // => use __vector instead of vector
120     #undef bool
121     #undef vector
122     #undef pixel
123   #elif defined  __ARM_NEON__
124     #define EIGEN_VECTORIZE
125     #define EIGEN_VECTORIZE_NEON
126     #include <arm_neon.h>
127   #endif
128 #endif
129
130 #if (defined _OPENMP) && (!defined EIGEN_DONT_PARALLELIZE)
131   #define EIGEN_HAS_OPENMP
132 #endif
133
134 #ifdef EIGEN_HAS_OPENMP
135 #include <omp.h>
136 #endif
137
138 // MSVC for windows mobile does not have the errno.h file
139 #if !(defined(_MSC_VER) && defined(_WIN32_WCE))
140 #define EIGEN_HAS_ERRNO
141 #endif
142
143 #ifdef EIGEN_HAS_ERRNO
144 #include <cerrno>
145 #endif
146 #include <cstddef>
147 #include <cstdlib>
148 #include <cmath>
149 #include <complex>
150 #include <cassert>
151 #include <functional>
152 #include <iosfwd>
153 #include <cstring>
154 #include <string>
155 #include <limits>
156 #include <climits> // for CHAR_BIT
157 // for min/max:
158 #include <algorithm>
159
160 // for outputting debug info
161 #ifdef EIGEN_DEBUG_ASSIGN
162 #include <iostream>
163 #endif
164
165 // required for __cpuid, needs to be included after cmath
166 #if defined(_MSC_VER) && (defined(_M_IX86)||defined(_M_X64))
167   #include <intrin.h>
168 #endif
169
170 #if (defined(_CPPUNWIND) || defined(__EXCEPTIONS)) && !defined(EIGEN_NO_EXCEPTIONS)
171   #define EIGEN_EXCEPTIONS
172 #endif
173
174 #ifdef EIGEN_EXCEPTIONS
175   #include <new>
176 #endif
177
178 // defined in bits/termios.h
179 #undef B0
180
181 /** \brief Namespace containing all symbols from the %Eigen library. */
182 namespace Eigen {
183
184 inline static const char *SimdInstructionSetsInUse(void) {
185 #if defined(EIGEN_VECTORIZE_SSE4_2)
186   return "SSE, SSE2, SSE3, SSSE3, SSE4.1, SSE4.2";
187 #elif defined(EIGEN_VECTORIZE_SSE4_1)
188   return "SSE, SSE2, SSE3, SSSE3, SSE4.1";
189 #elif defined(EIGEN_VECTORIZE_SSSE3)
190   return "SSE, SSE2, SSE3, SSSE3";
191 #elif defined(EIGEN_VECTORIZE_SSE3)
192   return "SSE, SSE2, SSE3";
193 #elif defined(EIGEN_VECTORIZE_SSE2)
194   return "SSE, SSE2";
195 #elif defined(EIGEN_VECTORIZE_ALTIVEC)
196   return "AltiVec";
197 #elif defined(EIGEN_VECTORIZE_NEON)
198   return "ARM NEON";
199 #else
200   return "None";
201 #endif
202 }
203
204 #define STAGE10_FULL_EIGEN2_API             10
205 #define STAGE20_RESOLVE_API_CONFLICTS       20
206 #define STAGE30_FULL_EIGEN3_API             30
207 #define STAGE40_FULL_EIGEN3_STRICTNESS      40
208 #define STAGE99_NO_EIGEN2_SUPPORT           99
209
210 #if   defined EIGEN2_SUPPORT_STAGE40_FULL_EIGEN3_STRICTNESS
211   #define EIGEN2_SUPPORT
212   #define EIGEN2_SUPPORT_STAGE STAGE40_FULL_EIGEN3_STRICTNESS
213 #elif defined EIGEN2_SUPPORT_STAGE30_FULL_EIGEN3_API
214   #define EIGEN2_SUPPORT
215   #define EIGEN2_SUPPORT_STAGE STAGE30_FULL_EIGEN3_API
216 #elif defined EIGEN2_SUPPORT_STAGE20_RESOLVE_API_CONFLICTS
217   #define EIGEN2_SUPPORT
218   #define EIGEN2_SUPPORT_STAGE STAGE20_RESOLVE_API_CONFLICTS
219 #elif defined EIGEN2_SUPPORT_STAGE10_FULL_EIGEN2_API
220   #define EIGEN2_SUPPORT
221   #define EIGEN2_SUPPORT_STAGE STAGE10_FULL_EIGEN2_API
222 #elif defined EIGEN2_SUPPORT
223   // default to stage 3, that's what it's always meant
224   #define EIGEN2_SUPPORT_STAGE30_FULL_EIGEN3_API
225   #define EIGEN2_SUPPORT_STAGE STAGE30_FULL_EIGEN3_API
226 #else
227   #define EIGEN2_SUPPORT_STAGE STAGE99_NO_EIGEN2_SUPPORT
228 #endif
229
230 #ifdef EIGEN2_SUPPORT
231 #undef minor
232 #endif
233
234 // we use size_t frequently and we'll never remember to prepend it with std:: everytime just to
235 // ensure QNX/QCC support
236 using std::size_t;
237 // gcc 4.6.0 wants std:: for ptrdiff_t 
238 using std::ptrdiff_t;
239
240 /** \defgroup Core_Module Core module
241   * This is the main module of Eigen providing dense matrix and vector support
242   * (both fixed and dynamic size) with all the features corresponding to a BLAS library
243   * and much more...
244   *
245   * \code
246   * #include <Eigen/Core>
247   * \endcode
248   */
249
250 #include "src/Core/util/Constants.h"
251 #include "src/Core/util/ForwardDeclarations.h"
252 #include "src/Core/util/Meta.h"
253 #include "src/Core/util/XprHelper.h"
254 #include "src/Core/util/StaticAssert.h"
255 #include "src/Core/util/Memory.h"
256
257 #include "src/Core/NumTraits.h"
258 #include "src/Core/MathFunctions.h"
259 #include "src/Core/GenericPacketMath.h"
260
261 #if defined EIGEN_VECTORIZE_SSE
262   #include "src/Core/arch/SSE/PacketMath.h"
263   #include "src/Core/arch/SSE/MathFunctions.h"
264   #include "src/Core/arch/SSE/Complex.h"
265 #elif defined EIGEN_VECTORIZE_ALTIVEC
266   #include "src/Core/arch/AltiVec/PacketMath.h"
267   #include "src/Core/arch/AltiVec/Complex.h"
268 #elif defined EIGEN_VECTORIZE_NEON
269   #include "src/Core/arch/NEON/PacketMath.h"
270   #include "src/Core/arch/NEON/Complex.h"
271 #endif
272
273 #include "src/Core/arch/Default/Settings.h"
274
275 #include "src/Core/Functors.h"
276 #include "src/Core/DenseCoeffsBase.h"
277 #include "src/Core/DenseBase.h"
278 #include "src/Core/MatrixBase.h"
279 #include "src/Core/EigenBase.h"
280
281 #ifndef EIGEN_PARSED_BY_DOXYGEN // work around Doxygen bug triggered by Assign.h r814874
282                                 // at least confirmed with Doxygen 1.5.5 and 1.5.6
283   #include "src/Core/Assign.h"
284 #endif
285
286 #include "src/Core/util/BlasUtil.h"
287 #include "src/Core/DenseStorage.h"
288 #include "src/Core/NestByValue.h"
289 #include "src/Core/ForceAlignedAccess.h"
290 #include "src/Core/ReturnByValue.h"
291 #include "src/Core/NoAlias.h"
292 #include "src/Core/PlainObjectBase.h"
293 #include "src/Core/Matrix.h"
294 #include "src/Core/Array.h"
295 #include "src/Core/CwiseBinaryOp.h"
296 #include "src/Core/CwiseUnaryOp.h"
297 #include "src/Core/CwiseNullaryOp.h"
298 #include "src/Core/CwiseUnaryView.h"
299 #include "src/Core/SelfCwiseBinaryOp.h"
300 #include "src/Core/Dot.h"
301 #include "src/Core/StableNorm.h"
302 #include "src/Core/MapBase.h"
303 #include "src/Core/Stride.h"
304 #include "src/Core/Map.h"
305 #include "src/Core/Block.h"
306 #include "src/Core/VectorBlock.h"
307 #include "src/Core/Transpose.h"
308 #include "src/Core/DiagonalMatrix.h"
309 #include "src/Core/Diagonal.h"
310 #include "src/Core/DiagonalProduct.h"
311 #include "src/Core/PermutationMatrix.h"
312 #include "src/Core/Transpositions.h"
313 #include "src/Core/Redux.h"
314 #include "src/Core/Visitor.h"
315 #include "src/Core/Fuzzy.h"
316 #include "src/Core/IO.h"
317 #include "src/Core/Swap.h"
318 #include "src/Core/CommaInitializer.h"
319 #include "src/Core/Flagged.h"
320 #include "src/Core/ProductBase.h"
321 #include "src/Core/Product.h"
322 #include "src/Core/TriangularMatrix.h"
323 #include "src/Core/SelfAdjointView.h"
324 #include "src/Core/SolveTriangular.h"
325 #include "src/Core/products/Parallelizer.h"
326 #include "src/Core/products/CoeffBasedProduct.h"
327 #include "src/Core/products/GeneralBlockPanelKernel.h"
328 #include "src/Core/products/GeneralMatrixVector.h"
329 #include "src/Core/products/GeneralMatrixMatrix.h"
330 #include "src/Core/products/GeneralMatrixMatrixTriangular.h"
331 #include "src/Core/products/SelfadjointMatrixVector.h"
332 #include "src/Core/products/SelfadjointMatrixMatrix.h"
333 #include "src/Core/products/SelfadjointProduct.h"
334 #include "src/Core/products/SelfadjointRank2Update.h"
335 #include "src/Core/products/TriangularMatrixVector.h"
336 #include "src/Core/products/TriangularMatrixMatrix.h"
337 #include "src/Core/products/TriangularSolverMatrix.h"
338 #include "src/Core/products/TriangularSolverVector.h"
339 #include "src/Core/BandMatrix.h"
340
341 #include "src/Core/BooleanRedux.h"
342 #include "src/Core/Select.h"
343 #include "src/Core/VectorwiseOp.h"
344 #include "src/Core/Random.h"
345 #include "src/Core/Replicate.h"
346 #include "src/Core/Reverse.h"
347 #include "src/Core/ArrayBase.h"
348 #include "src/Core/ArrayWrapper.h"
349
350 } // namespace Eigen
351
352 #include "src/Core/GlobalFunctions.h"
353
354 #include "src/Core/util/ReenableStupidWarnings.h"
355
356 #ifdef EIGEN2_SUPPORT
357 #include "Eigen2Support"
358 #endif
359
360 #endif // EIGEN_CORE_H