Eigen  5.0.1-dev+60122df6
 
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 <gael.guennebaud@inria.fr>
5// Copyright (C) 2007-2011 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_CORE_MODULE_H
12#define EIGEN_CORE_MODULE_H
13
14// Eigen version information.
15#include "Version"
16
17// first thing Eigen does: stop the compiler from reporting useless warnings.
18#include "src/Core/util/DisableStupidWarnings.h"
19
20// then include this file where all our macros are defined. It's really important to do it first because
21// it's where we do all the compiler/OS/arch detections and define most defaults.
22#include "src/Core/util/Macros.h"
23
24// This detects SSE/AVX/NEON/etc. and configure alignment settings
25#include "src/Core/util/ConfigureVectorization.h"
26
27// We need cuda_runtime.h/hip_runtime.h to ensure that
28// the EIGEN_USING_STD macro works properly on the device side
29#if defined(EIGEN_CUDACC)
30#include <cuda_runtime.h>
31#elif defined(EIGEN_HIPCC)
32#include <hip/hip_runtime.h>
33#endif
34
35#ifdef EIGEN_EXCEPTIONS
36#include <new>
37#endif
38
39// Disable the ipa-cp-clone optimization flag with MinGW 6.x or older (enabled by default with -O3)
40// See http://eigen.tuxfamily.org/bz/show_bug.cgi?id=556 for details.
41#if EIGEN_COMP_MINGW && EIGEN_GNUC_STRICT_LESS_THAN(6, 0, 0)
42#pragma GCC optimize("-fno-ipa-cp-clone")
43#endif
44
45// Prevent ICC from specializing std::complex operators that silently fail
46// on device. This allows us to use our own device-compatible specializations
47// instead.
48#if EIGEN_COMP_ICC && defined(EIGEN_GPU_COMPILE_PHASE) && !defined(_OVERRIDE_COMPLEX_SPECIALIZATION_)
49#define _OVERRIDE_COMPLEX_SPECIALIZATION_ 1
50#endif
51#include <complex>
52
53// this include file manages BLAS and MKL related macros
54// and inclusion of their respective header files
55#include "src/Core/util/MKL_support.h"
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 <functional>
86#ifndef EIGEN_NO_IO
87#include <sstream>
88#include <iosfwd>
89#endif
90#include <cstring>
91#include <string>
92#include <limits>
93#include <climits> // for CHAR_BIT
94// for min/max:
95#include <algorithm>
96
97#include <array>
98#include <memory>
99#include <vector>
100
101// for std::is_nothrow_move_assignable
102#include <type_traits>
103
104// for std::this_thread::yield().
105#if !defined(EIGEN_USE_BLAS) && (defined(EIGEN_HAS_OPENMP) || defined(EIGEN_GEMM_THREADPOOL))
106#include <thread>
107#endif
108
109// for __cpp_lib feature test macros
110#if defined(__has_include) && __has_include(<version>)
111#include <version>
112#endif
113
114// for std::bit_cast()
115#if defined(__cpp_lib_bit_cast) && __cpp_lib_bit_cast >= 201806L
116#include <bit>
117#endif
118
119// for outputting debug info
120#ifdef EIGEN_DEBUG_ASSIGN
121#include <iostream>
122#endif
123
124// required for __cpuid, needs to be included after cmath
125// also required for _BitScanReverse on Windows on ARM
126#if EIGEN_COMP_MSVC && (EIGEN_ARCH_i386_OR_x86_64 || EIGEN_ARCH_ARM64) && !EIGEN_OS_WINCE
127#include <intrin.h>
128#endif
129
130#if defined(EIGEN_USE_SYCL)
131#undef min
132#undef max
133#undef isnan
134#undef isinf
135#undef isfinite
136#include <CL/sycl.hpp>
137#include <map>
138#include <thread>
139#include <utility>
140#ifndef EIGEN_SYCL_LOCAL_THREAD_DIM0
141#define EIGEN_SYCL_LOCAL_THREAD_DIM0 16
142#endif
143#ifndef EIGEN_SYCL_LOCAL_THREAD_DIM1
144#define EIGEN_SYCL_LOCAL_THREAD_DIM1 16
145#endif
146#endif
147
148#if defined EIGEN2_SUPPORT_STAGE40_FULL_EIGEN3_STRICTNESS || defined EIGEN2_SUPPORT_STAGE30_FULL_EIGEN3_API || \
149 defined EIGEN2_SUPPORT_STAGE20_RESOLVE_API_CONFLICTS || defined EIGEN2_SUPPORT_STAGE10_FULL_EIGEN2_API || \
150 defined EIGEN2_SUPPORT
151// This will generate an error message:
152#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
153#endif
154
155namespace Eigen {
156
157// we use size_t frequently and we'll never remember to prepend it with std:: every time just to
158// ensure QNX/QCC support
159using std::size_t;
160// gcc 4.6.0 wants std:: for ptrdiff_t
161using std::ptrdiff_t;
162
163} // namespace Eigen
164
174
175#ifdef EIGEN_USE_LAPACKE
176#ifdef EIGEN_USE_MKL
177#include "mkl_lapacke.h"
178#else
179#include "src/misc/lapacke.h"
180#endif
181#endif
182
183// IWYU pragma: begin_exports
184#include "src/Core/util/Constants.h"
185#include "src/Core/util/Meta.h"
186#include "src/Core/util/Assert.h"
187#include "src/Core/util/ForwardDeclarations.h"
188#include "src/Core/util/StaticAssert.h"
189#include "src/Core/util/XprHelper.h"
190#include "src/Core/util/Memory.h"
191#include "src/Core/util/IntegralConstant.h"
192#include "src/Core/util/Serializer.h"
193#include "src/Core/util/SymbolicIndex.h"
194#include "src/Core/util/EmulateArray.h"
195#include "src/Core/util/MoreMeta.h"
196
197#include "src/Core/NumTraits.h"
198#include "src/Core/MathFunctions.h"
199#include "src/Core/RandomImpl.h"
200#include "src/Core/GenericPacketMath.h"
201#include "src/Core/MathFunctionsImpl.h"
202#include "src/Core/arch/Default/ConjHelper.h"
203// Generic half float support
204#include "src/Core/arch/Default/Half.h"
205#include "src/Core/arch/Default/BFloat16.h"
206#include "src/Core/arch/Default/GenericPacketMathFunctionsFwd.h"
207
208#if defined EIGEN_VECTORIZE_AVX512
209#include "src/Core/arch/SSE/PacketMath.h"
210#include "src/Core/arch/SSE/Reductions.h"
211#include "src/Core/arch/AVX/PacketMath.h"
212#include "src/Core/arch/AVX/Reductions.h"
213#include "src/Core/arch/AVX512/PacketMath.h"
214#include "src/Core/arch/AVX512/Reductions.h"
215#if defined EIGEN_VECTORIZE_AVX512FP16
216#include "src/Core/arch/AVX512/PacketMathFP16.h"
217#endif
218#include "src/Core/arch/SSE/TypeCasting.h"
219#include "src/Core/arch/AVX/TypeCasting.h"
220#include "src/Core/arch/AVX512/TypeCasting.h"
221#if defined EIGEN_VECTORIZE_AVX512FP16
222#include "src/Core/arch/AVX512/TypeCastingFP16.h"
223#endif
224#include "src/Core/arch/SSE/Complex.h"
225#include "src/Core/arch/AVX/Complex.h"
226#include "src/Core/arch/AVX512/Complex.h"
227#include "src/Core/arch/SSE/MathFunctions.h"
228#include "src/Core/arch/AVX/MathFunctions.h"
229#include "src/Core/arch/AVX512/MathFunctions.h"
230#if defined EIGEN_VECTORIZE_AVX512FP16
231#include "src/Core/arch/AVX512/MathFunctionsFP16.h"
232#endif
233#include "src/Core/arch/AVX512/TrsmKernel.h"
234#elif defined EIGEN_VECTORIZE_AVX
235// Use AVX for floats and doubles, SSE for integers
236#include "src/Core/arch/SSE/PacketMath.h"
237#include "src/Core/arch/SSE/Reductions.h"
238#include "src/Core/arch/SSE/TypeCasting.h"
239#include "src/Core/arch/SSE/Complex.h"
240#include "src/Core/arch/AVX/PacketMath.h"
241#include "src/Core/arch/AVX/Reductions.h"
242#include "src/Core/arch/AVX/TypeCasting.h"
243#include "src/Core/arch/AVX/Complex.h"
244#include "src/Core/arch/SSE/MathFunctions.h"
245#include "src/Core/arch/AVX/MathFunctions.h"
246#elif defined EIGEN_VECTORIZE_SSE
247#include "src/Core/arch/SSE/PacketMath.h"
248#include "src/Core/arch/SSE/Reductions.h"
249#include "src/Core/arch/SSE/TypeCasting.h"
250#include "src/Core/arch/SSE/MathFunctions.h"
251#include "src/Core/arch/SSE/Complex.h"
252#endif
253
254#if defined(EIGEN_VECTORIZE_ALTIVEC) || defined(EIGEN_VECTORIZE_VSX)
255#include "src/Core/arch/AltiVec/PacketMath.h"
256#include "src/Core/arch/AltiVec/TypeCasting.h"
257#include "src/Core/arch/AltiVec/MathFunctions.h"
258#include "src/Core/arch/AltiVec/Complex.h"
259#elif defined EIGEN_VECTORIZE_NEON
260#include "src/Core/arch/NEON/PacketMath.h"
261#include "src/Core/arch/NEON/TypeCasting.h"
262#include "src/Core/arch/NEON/MathFunctions.h"
263#include "src/Core/arch/NEON/Complex.h"
264#elif defined EIGEN_VECTORIZE_LSX
265#include "src/Core/arch/LSX/PacketMath.h"
266#include "src/Core/arch/LSX/TypeCasting.h"
267#include "src/Core/arch/LSX/MathFunctions.h"
268#include "src/Core/arch/LSX/Complex.h"
269#elif defined EIGEN_VECTORIZE_SVE
270#include "src/Core/arch/SVE/PacketMath.h"
271#include "src/Core/arch/SVE/TypeCasting.h"
272#include "src/Core/arch/SVE/MathFunctions.h"
273#elif defined EIGEN_VECTORIZE_ZVECTOR
274#include "src/Core/arch/ZVector/PacketMath.h"
275#include "src/Core/arch/ZVector/MathFunctions.h"
276#include "src/Core/arch/ZVector/Complex.h"
277#elif defined EIGEN_VECTORIZE_MSA
278#include "src/Core/arch/MSA/PacketMath.h"
279#include "src/Core/arch/MSA/MathFunctions.h"
280#include "src/Core/arch/MSA/Complex.h"
281#elif defined EIGEN_VECTORIZE_HVX
282#include "src/Core/arch/HVX/PacketMath.h"
283#endif
284
285#if defined EIGEN_VECTORIZE_GPU
286#include "src/Core/arch/GPU/PacketMath.h"
287#include "src/Core/arch/GPU/MathFunctions.h"
288#include "src/Core/arch/GPU/TypeCasting.h"
289#endif
290
291#if defined(EIGEN_USE_SYCL)
292#include "src/Core/arch/SYCL/InteropHeaders.h"
293#if !defined(EIGEN_DONT_VECTORIZE_SYCL)
294#include "src/Core/arch/SYCL/PacketMath.h"
295#include "src/Core/arch/SYCL/MathFunctions.h"
296#include "src/Core/arch/SYCL/TypeCasting.h"
297#endif
298#endif
299
300#include "src/Core/arch/Default/Settings.h"
301// This file provides generic implementations valid for scalar as well
302#include "src/Core/arch/Default/GenericPacketMathFunctions.h"
303
304#include "src/Core/functors/TernaryFunctors.h"
305#include "src/Core/functors/BinaryFunctors.h"
306#include "src/Core/functors/UnaryFunctors.h"
307#include "src/Core/functors/NullaryFunctors.h"
308#include "src/Core/functors/StlFunctors.h"
309#include "src/Core/functors/AssignmentFunctors.h"
310
311// Specialized functors for GPU.
312#ifdef EIGEN_GPUCC
313#include "src/Core/arch/GPU/Complex.h"
314#endif
315
316// Specializations of vectorized activation functions for NEON.
317#ifdef EIGEN_VECTORIZE_NEON
318#include "src/Core/arch/NEON/UnaryFunctors.h"
319#endif
320
321#include "src/Core/util/IndexedViewHelper.h"
322#include "src/Core/util/ReshapedHelper.h"
323#include "src/Core/ArithmeticSequence.h"
324#ifndef EIGEN_NO_IO
325#include "src/Core/IO.h"
326#endif
327#include "src/Core/DenseCoeffsBase.h"
328#include "src/Core/DenseBase.h"
329#include "src/Core/MatrixBase.h"
330#include "src/Core/EigenBase.h"
331
332#include "src/Core/Product.h"
333#include "src/Core/CoreEvaluators.h"
334#include "src/Core/AssignEvaluator.h"
335#include "src/Core/RealView.h"
336#include "src/Core/Assign.h"
337
338#include "src/Core/ArrayBase.h"
339#include "src/Core/util/BlasUtil.h"
340#include "src/Core/DenseStorage.h"
341#include "src/Core/NestByValue.h"
342
343// #include "src/Core/ForceAlignedAccess.h"
344
345#include "src/Core/ReturnByValue.h"
346#include "src/Core/NoAlias.h"
347#include "src/Core/PlainObjectBase.h"
348#include "src/Core/Matrix.h"
349#include "src/Core/Array.h"
350#include "src/Core/Fill.h"
351#include "src/Core/CwiseTernaryOp.h"
352#include "src/Core/CwiseBinaryOp.h"
353#include "src/Core/CwiseUnaryOp.h"
354#include "src/Core/CwiseNullaryOp.h"
355#include "src/Core/CwiseUnaryView.h"
356#include "src/Core/SelfCwiseBinaryOp.h"
357#include "src/Core/InnerProduct.h"
358#include "src/Core/Dot.h"
359#include "src/Core/StableNorm.h"
360#include "src/Core/Stride.h"
361#include "src/Core/MapBase.h"
362#include "src/Core/Map.h"
363#include "src/Core/Ref.h"
364#include "src/Core/Block.h"
365#include "src/Core/VectorBlock.h"
366#include "src/Core/IndexedView.h"
367#include "src/Core/Reshaped.h"
368#include "src/Core/Transpose.h"
369#include "src/Core/DiagonalMatrix.h"
370#include "src/Core/Diagonal.h"
371#include "src/Core/DiagonalProduct.h"
372#include "src/Core/SkewSymmetricMatrix3.h"
373#include "src/Core/Redux.h"
374#include "src/Core/Visitor.h"
375#include "src/Core/FindCoeff.h"
376#include "src/Core/Fuzzy.h"
377#include "src/Core/Swap.h"
378#include "src/Core/CommaInitializer.h"
379#include "src/Core/GeneralProduct.h"
380#include "src/Core/Solve.h"
381#include "src/Core/Inverse.h"
382#include "src/Core/SolverBase.h"
383#include "src/Core/PermutationMatrix.h"
384#include "src/Core/Transpositions.h"
385#include "src/Core/TriangularMatrix.h"
386#include "src/Core/SelfAdjointView.h"
387#include "src/Core/products/GeneralBlockPanelKernel.h"
388#include "src/Core/DeviceWrapper.h"
389#ifdef EIGEN_GEMM_THREADPOOL
390#include "ThreadPool"
391#endif
392#include "src/Core/products/Parallelizer.h"
393#include "src/Core/ProductEvaluators.h"
394#include "src/Core/products/GeneralMatrixVector.h"
395#include "src/Core/products/GeneralMatrixMatrix.h"
396#include "src/Core/SolveTriangular.h"
397#include "src/Core/products/GeneralMatrixMatrixTriangular.h"
398#include "src/Core/products/SelfadjointMatrixVector.h"
399#include "src/Core/products/SelfadjointMatrixMatrix.h"
400#include "src/Core/products/SelfadjointProduct.h"
401#include "src/Core/products/SelfadjointRank2Update.h"
402#include "src/Core/products/TriangularMatrixVector.h"
403#include "src/Core/products/TriangularMatrixMatrix.h"
404#include "src/Core/products/TriangularSolverMatrix.h"
405#include "src/Core/products/TriangularSolverVector.h"
406#include "src/Core/BandMatrix.h"
407#include "src/Core/CoreIterators.h"
408#include "src/Core/ConditionEstimator.h"
409
410#if defined(EIGEN_VECTORIZE_VSX)
411#include "src/Core/arch/AltiVec/MatrixProduct.h"
412#elif defined EIGEN_VECTORIZE_NEON
413#include "src/Core/arch/NEON/GeneralBlockPanelKernel.h"
414#elif defined EIGEN_VECTORIZE_LSX
415#include "src/Core/arch/LSX/GeneralBlockPanelKernel.h"
416#endif
417
418#if defined(EIGEN_VECTORIZE_AVX512)
419#include "src/Core/arch/AVX512/GemmKernel.h"
420#endif
421
422#include "src/Core/Select.h"
423#include "src/Core/VectorwiseOp.h"
424#include "src/Core/PartialReduxEvaluator.h"
425#include "src/Core/Random.h"
426#include "src/Core/Replicate.h"
427#include "src/Core/Reverse.h"
428#include "src/Core/ArrayWrapper.h"
429#include "src/Core/StlIterators.h"
430
431#ifdef EIGEN_USE_BLAS
432#include "src/Core/products/GeneralMatrixMatrix_BLAS.h"
433#include "src/Core/products/GeneralMatrixVector_BLAS.h"
434#include "src/Core/products/GeneralMatrixMatrixTriangular_BLAS.h"
435#include "src/Core/products/SelfadjointMatrixMatrix_BLAS.h"
436#include "src/Core/products/SelfadjointMatrixVector_BLAS.h"
437#include "src/Core/products/TriangularMatrixMatrix_BLAS.h"
438#include "src/Core/products/TriangularMatrixVector_BLAS.h"
439#include "src/Core/products/TriangularSolverMatrix_BLAS.h"
440#endif // EIGEN_USE_BLAS
441
442#ifdef EIGEN_USE_MKL_VML
443#include "src/Core/Assign_MKL.h"
444#endif
445
446#include "src/Core/GlobalFunctions.h"
447// IWYU pragma: end_exports
448
449#include "src/Core/util/ReenableStupidWarnings.h"
450
451#endif // EIGEN_CORE_MODULE_H
Eigen
Namespace containing all symbols from the Eigen library.
Definition B01_Experimental.dox:1