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