1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008 Gael Guennebaud <[email protected]>
5// Copyright (C) 2007-2011 Benoit Jacob <[email protected]>
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_CORE_MODULE_H
12#define EIGEN_CORE_MODULE_H
13
14// first thing Eigen does: stop the compiler from reporting useless warnings.
15#include "src/Core/util/DisableStupidWarnings.h"
16
17// then include this file where all our macros are defined. It's really important to do it first because
18// it's where we do all the compiler/OS/arch detections and define most defaults.
19#include "src/Core/util/Macros.h"
20
21// This detects SSE/AVX/NEON/etc. and configure alignment settings
22#include "src/Core/util/ConfigureVectorization.h"
23
24// We need cuda_runtime.h/hip_runtime.h to ensure that
25// the EIGEN_USING_STD macro works properly on the device side
26#if defined(EIGEN_CUDACC)
27 #include <cuda_runtime.h>
28#elif defined(EIGEN_HIPCC)
29 #include <hip/hip_runtime.h>
30#endif
31
32
33#ifdef EIGEN_EXCEPTIONS
34 #include <new>
35#endif
36
37// Disable the ipa-cp-clone optimization flag with MinGW 6.x or newer (enabled by default with -O3)
38// See http://eigen.tuxfamily.org/bz/show_bug.cgi?id=556 for details.
39#if EIGEN_COMP_MINGW && EIGEN_GNUC_AT_MOST(5,5)
40 #pragma GCC optimize ("-fno-ipa-cp-clone")
41#endif
42
43// Prevent ICC from specializing std::complex operators that silently fail
44// on device. This allows us to use our own device-compatible specializations
45// instead.
46#if defined(EIGEN_COMP_ICC) && defined(EIGEN_GPU_COMPILE_PHASE) \
47 && !defined(_OVERRIDE_COMPLEX_SPECIALIZATION_)
48#define _OVERRIDE_COMPLEX_SPECIALIZATION_ 1
49#endif
50#include <complex>
51
52// this include file manages BLAS and MKL related macros
53// and inclusion of their respective header files
54#include "src/Core/util/MKL_support.h"
55
56
57#if defined(EIGEN_HAS_CUDA_FP16) || defined(EIGEN_HAS_HIP_FP16)
58 #define EIGEN_HAS_GPU_FP16
59#endif
60
61#if defined(EIGEN_HAS_CUDA_BF16) || defined(EIGEN_HAS_HIP_BF16)
62 #define EIGEN_HAS_GPU_BF16
63#endif
64
65#if (defined _OPENMP) && (!defined EIGEN_DONT_PARALLELIZE)
66 #define EIGEN_HAS_OPENMP
67#endif
68
69#ifdef EIGEN_HAS_OPENMP
70#include <atomic>
71#include <omp.h>
72#endif
73
74// MSVC for windows mobile does not have the errno.h file
75#if !(EIGEN_COMP_MSVC && EIGEN_OS_WINCE) && !EIGEN_COMP_ARM
76#define EIGEN_HAS_ERRNO
77#endif
78
79#ifdef EIGEN_HAS_ERRNO
80#include <cerrno>
81#endif
82#include <cstddef>
83#include <cstdlib>
84#include <cmath>
85#include <cassert>
86#include <functional>
87#ifndef EIGEN_NO_IO
88 #include <sstream>
89 #include <iosfwd>
90#endif
91#include <cstring>
92#include <string>
93#include <limits>
94#include <climits> // for CHAR_BIT
95// for min/max:
96#include <algorithm>
97
98#include <array>
99
100// for std::is_nothrow_move_assignable
101#include <type_traits>
102
103// for outputting debug info
104#ifdef EIGEN_DEBUG_ASSIGN
105#include <iostream>
106#endif
107
108// required for __cpuid, needs to be included after cmath
109// also required for _BitScanReverse on Windows on ARM
110#if EIGEN_COMP_MSVC && (EIGEN_ARCH_i386_OR_x86_64 || EIGEN_ARCH_ARM64) && !EIGEN_OS_WINCE
111 #include <intrin.h>
112#endif
113
114#if defined(EIGEN_USE_SYCL)
115 #undef min
116 #undef max
117 #undef isnan
118 #undef isinf
119 #undef isfinite
120 #include <CL/sycl.hpp>
121 #include <map>
122 #include <memory>
123 #include <utility>
124 #include <thread>
125 #ifndef EIGEN_SYCL_LOCAL_THREAD_DIM0
126 #define EIGEN_SYCL_LOCAL_THREAD_DIM0 16
127 #endif
128 #ifndef EIGEN_SYCL_LOCAL_THREAD_DIM1
129 #define EIGEN_SYCL_LOCAL_THREAD_DIM1 16
130 #endif
131#endif
132
133
134#if defined EIGEN2_SUPPORT_STAGE40_FULL_EIGEN3_STRICTNESS || defined EIGEN2_SUPPORT_STAGE30_FULL_EIGEN3_API || defined EIGEN2_SUPPORT_STAGE20_RESOLVE_API_CONFLICTS || defined EIGEN2_SUPPORT_STAGE10_FULL_EIGEN2_API || defined EIGEN2_SUPPORT
135// This will generate an error message:
136#error Eigen2-support is only available up to version 3.2. Please go to "http://eigen.tuxfamily.org/index.php?title=Eigen2" for further information
137#endif
138
139namespace Eigen {
140
141// we use size_t frequently and we'll never remember to prepend it with std:: every time just to
142// ensure QNX/QCC support
143using std::size_t;
144// gcc 4.6.0 wants std:: for ptrdiff_t
145using std::ptrdiff_t;
146
147}
148
149/** \defgroup Core_Module Core module
150 * This is the main module of Eigen providing dense matrix and vector support
151 * (both fixed and dynamic size) with all the features corresponding to a BLAS library
152 * and much more...
153 *
154 * \code
155 * #include <Eigen/Core>
156 * \endcode
157 */
158
159#include "src/Core/util/Constants.h"
160#include "src/Core/util/Meta.h"
161#include "src/Core/util/ForwardDeclarations.h"
162#include "src/Core/util/StaticAssert.h"
163#include "src/Core/util/XprHelper.h"
164#include "src/Core/util/Memory.h"
165#include "src/Core/util/IntegralConstant.h"
166#include "src/Core/util/Serializer.h"
167#include "src/Core/util/SymbolicIndex.h"
168
169#include "src/Core/NumTraits.h"
170#include "src/Core/MathFunctions.h"
171#include "src/Core/GenericPacketMath.h"
172#include "src/Core/MathFunctionsImpl.h"
173#include "src/Core/arch/Default/ConjHelper.h"
174// Generic half float support
175#include "src/Core/arch/Default/Half.h"
176#include "src/Core/arch/Default/BFloat16.h"
177#include "src/Core/arch/Default/TypeCasting.h"
178#include "src/Core/arch/Default/GenericPacketMathFunctionsFwd.h"
179
180#if defined EIGEN_VECTORIZE_AVX512
181 #if defined EIGEN_VECTORIZE_AVX512FP16
182 #include "src/Core/arch/AVX512/PacketMathFP16.h"
183 #endif
184 #include "src/Core/arch/SSE/PacketMath.h"
185 #include "src/Core/arch/SSE/TypeCasting.h"
186 #include "src/Core/arch/SSE/Complex.h"
187 #include "src/Core/arch/AVX/PacketMath.h"
188 #include "src/Core/arch/AVX/TypeCasting.h"
189 #include "src/Core/arch/AVX/Complex.h"
190 #include "src/Core/arch/AVX512/PacketMath.h"
191 #include "src/Core/arch/AVX512/TypeCasting.h"
192 #include "src/Core/arch/AVX512/Complex.h"
193 #include "src/Core/arch/SSE/MathFunctions.h"
194 #include "src/Core/arch/AVX/MathFunctions.h"
195 #include "src/Core/arch/AVX512/MathFunctions.h"
196 #include "src/Core/arch/AVX512/TrsmKernel.h"
197#elif defined EIGEN_VECTORIZE_AVX
198 // Use AVX for floats and doubles, SSE for integers
199 #include "src/Core/arch/SSE/PacketMath.h"
200 #include "src/Core/arch/SSE/TypeCasting.h"
201 #include "src/Core/arch/SSE/Complex.h"
202 #include "src/Core/arch/AVX/PacketMath.h"
203 #include "src/Core/arch/AVX/TypeCasting.h"
204 #include "src/Core/arch/AVX/Complex.h"
205 #include "src/Core/arch/SSE/MathFunctions.h"
206 #include "src/Core/arch/AVX/MathFunctions.h"
207#elif defined EIGEN_VECTORIZE_SSE
208 #include "src/Core/arch/SSE/PacketMath.h"
209 #include "src/Core/arch/SSE/TypeCasting.h"
210 #include "src/Core/arch/SSE/MathFunctions.h"
211 #include "src/Core/arch/SSE/Complex.h"
212#elif defined(EIGEN_VECTORIZE_ALTIVEC) || defined(EIGEN_VECTORIZE_VSX)
213 #include "src/Core/arch/AltiVec/PacketMath.h"
214 #include "src/Core/arch/AltiVec/MathFunctions.h"
215 #include "src/Core/arch/AltiVec/Complex.h"
216#elif defined EIGEN_VECTORIZE_NEON
217 #include "src/Core/arch/NEON/PacketMath.h"
218 #include "src/Core/arch/NEON/TypeCasting.h"
219 #include "src/Core/arch/NEON/MathFunctions.h"
220 #include "src/Core/arch/NEON/Complex.h"
221#elif defined EIGEN_VECTORIZE_SVE
222 #include "src/Core/arch/SVE/PacketMath.h"
223 #include "src/Core/arch/SVE/TypeCasting.h"
224 #include "src/Core/arch/SVE/MathFunctions.h"
225#elif defined EIGEN_VECTORIZE_ZVECTOR
226 #include "src/Core/arch/ZVector/PacketMath.h"
227 #include "src/Core/arch/ZVector/MathFunctions.h"
228 #include "src/Core/arch/ZVector/Complex.h"
229#elif defined EIGEN_VECTORIZE_MSA
230 #include "src/Core/arch/MSA/PacketMath.h"
231 #include "src/Core/arch/MSA/MathFunctions.h"
232 #include "src/Core/arch/MSA/Complex.h"
233#endif
234
235#if defined EIGEN_VECTORIZE_GPU
236 #include "src/Core/arch/GPU/PacketMath.h"
237 #include "src/Core/arch/GPU/MathFunctions.h"
238 #include "src/Core/arch/GPU/TypeCasting.h"
239#endif
240
241#if defined(EIGEN_USE_SYCL)
242 #include "src/Core/arch/SYCL/SyclMemoryModel.h"
243 #include "src/Core/arch/SYCL/InteropHeaders.h"
244#if !defined(EIGEN_DONT_VECTORIZE_SYCL)
245 #include "src/Core/arch/SYCL/PacketMath.h"
246 #include "src/Core/arch/SYCL/MathFunctions.h"
247 #include "src/Core/arch/SYCL/TypeCasting.h"
248#endif
249#endif
250
251#include "src/Core/arch/Default/Settings.h"
252// This file provides generic implementations valid for scalar as well
253#include "src/Core/arch/Default/GenericPacketMathFunctions.h"
254
255#include "src/Core/functors/TernaryFunctors.h"
256#include "src/Core/functors/BinaryFunctors.h"
257#include "src/Core/functors/UnaryFunctors.h"
258#include "src/Core/functors/NullaryFunctors.h"
259#include "src/Core/functors/StlFunctors.h"
260#include "src/Core/functors/AssignmentFunctors.h"
261
262// Specialized functors for GPU.
263#ifdef EIGEN_GPUCC
264#include "src/Core/arch/GPU/Complex.h"
265#endif
266
267// Specializations of vectorized activation functions for NEON.
268#ifdef EIGEN_VECTORIZE_NEON
269#include "src/Core/arch/NEON/UnaryFunctors.h"
270#endif
271
272#include "src/Core/util/IndexedViewHelper.h"
273#include "src/Core/util/ReshapedHelper.h"
274#include "src/Core/ArithmeticSequence.h"
275#ifndef EIGEN_NO_IO
276 #include "src/Core/IO.h"
277#endif
278#include "src/Core/DenseCoeffsBase.h"
279#include "src/Core/DenseBase.h"
280#include "src/Core/MatrixBase.h"
281#include "src/Core/EigenBase.h"
282
283#include "src/Core/Product.h"
284#include "src/Core/CoreEvaluators.h"
285#include "src/Core/AssignEvaluator.h"
286
287#ifndef EIGEN_PARSED_BY_DOXYGEN // work around Doxygen bug triggered by Assign.h r814874
288 // at least confirmed with Doxygen 1.5.5 and 1.5.6
289 #include "src/Core/Assign.h"
290#endif
291
292#include "src/Core/ArrayBase.h"
293#include "src/Core/util/BlasUtil.h"
294#include "src/Core/DenseStorage.h"
295#include "src/Core/NestByValue.h"
296
297// #include "src/Core/ForceAlignedAccess.h"
298
299#include "src/Core/ReturnByValue.h"
300#include "src/Core/NoAlias.h"
301#include "src/Core/PlainObjectBase.h"
302#include "src/Core/Matrix.h"
303#include "src/Core/Array.h"
304#include "src/Core/CwiseTernaryOp.h"
305#include "src/Core/CwiseBinaryOp.h"
306#include "src/Core/CwiseUnaryOp.h"
307#include "src/Core/CwiseNullaryOp.h"
308#include "src/Core/CwiseUnaryView.h"
309#include "src/Core/SelfCwiseBinaryOp.h"
310#include "src/Core/Dot.h"
311#include "src/Core/StableNorm.h"
312#include "src/Core/Stride.h"
313#include "src/Core/MapBase.h"
314#include "src/Core/Map.h"
315#include "src/Core/Ref.h"
316#include "src/Core/Block.h"
317#include "src/Core/VectorBlock.h"
318#include "src/Core/IndexedView.h"
319#include "src/Core/Reshaped.h"
320#include "src/Core/Transpose.h"
321#include "src/Core/DiagonalMatrix.h"
322#include "src/Core/Diagonal.h"
323#include "src/Core/DiagonalProduct.h"
324#include "src/Core/SkewSymmetricMatrix3.h"
325#include "src/Core/Redux.h"
326#include "src/Core/Visitor.h"
327#include "src/Core/Fuzzy.h"
328#include "src/Core/Swap.h"
329#include "src/Core/CommaInitializer.h"
330#include "src/Core/GeneralProduct.h"
331#include "src/Core/Solve.h"
332#include "src/Core/Inverse.h"
333#include "src/Core/SolverBase.h"
334#include "src/Core/PermutationMatrix.h"
335#include "src/Core/Transpositions.h"
336#include "src/Core/TriangularMatrix.h"
337#include "src/Core/SelfAdjointView.h"
338#include "src/Core/products/GeneralBlockPanelKernel.h"
339#include "src/Core/products/Parallelizer.h"
340#include "src/Core/ProductEvaluators.h"
341#include "src/Core/products/GeneralMatrixVector.h"
342#include "src/Core/products/GeneralMatrixMatrix.h"
343#include "src/Core/SolveTriangular.h"
344#include "src/Core/products/GeneralMatrixMatrixTriangular.h"
345#include "src/Core/products/SelfadjointMatrixVector.h"
346#include "src/Core/products/SelfadjointMatrixMatrix.h"
347#include "src/Core/products/SelfadjointProduct.h"
348#include "src/Core/products/SelfadjointRank2Update.h"
349#include "src/Core/products/TriangularMatrixVector.h"
350#include "src/Core/products/TriangularMatrixMatrix.h"
351#include "src/Core/products/TriangularSolverMatrix.h"
352#include "src/Core/products/TriangularSolverVector.h"
353#include "src/Core/BandMatrix.h"
354#include "src/Core/CoreIterators.h"
355#include "src/Core/ConditionEstimator.h"
356
357#if defined(EIGEN_VECTORIZE_VSX)
358 #include "src/Core/arch/AltiVec/MatrixProduct.h"
359#elif defined EIGEN_VECTORIZE_NEON
360 #include "src/Core/arch/NEON/GeneralBlockPanelKernel.h"
361#endif
362
363#if defined(EIGEN_VECTORIZE_AVX512)
364 #include "src/Core/arch/AVX512/GemmKernel.h"
365#endif
366
367#include "src/Core/BooleanRedux.h"
368#include "src/Core/Select.h"
369#include "src/Core/VectorwiseOp.h"
370#include "src/Core/PartialReduxEvaluator.h"
371#include "src/Core/Random.h"
372#include "src/Core/Replicate.h"
373#include "src/Core/Reverse.h"
374#include "src/Core/ArrayWrapper.h"
375#include "src/Core/StlIterators.h"
376
377#ifdef EIGEN_USE_BLAS
378#include "src/Core/products/GeneralMatrixMatrix_BLAS.h"
379#include "src/Core/products/GeneralMatrixVector_BLAS.h"
380#include "src/Core/products/GeneralMatrixMatrixTriangular_BLAS.h"
381#include "src/Core/products/SelfadjointMatrixMatrix_BLAS.h"
382#include "src/Core/products/SelfadjointMatrixVector_BLAS.h"
383#include "src/Core/products/TriangularMatrixMatrix_BLAS.h"
384#include "src/Core/products/TriangularMatrixVector_BLAS.h"
385#include "src/Core/products/TriangularSolverMatrix_BLAS.h"
386#endif // EIGEN_USE_BLAS
387
388#ifdef EIGEN_USE_MKL_VML
389#include "src/Core/Assign_MKL.h"
390#endif
391
392#include "src/Core/GlobalFunctions.h"
393
394#include "src/Core/util/ReenableStupidWarnings.h"
395
396#endif // EIGEN_CORE_MODULE_H
397