Eigen  5.0.1
 
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// SPDX-License-Identifier: MPL-2.0
11
12#ifndef EIGEN_CORE_MODULE_H
13#define EIGEN_CORE_MODULE_H
14
15// Eigen version information.
16#include "Version"
17
18// first thing Eigen does: stop the compiler from reporting useless warnings.
19#include "src/Core/util/DisableStupidWarnings.h"
20
21// then include this file where all our macros are defined. It's really important to do it first because
22// it's where we do all the compiler/OS/arch detections and define most defaults.
23#include "src/Core/util/Macros.h"
24
25// This detects SSE/AVX/NEON/etc. and configure alignment settings
26#include "src/Core/util/ConfigureVectorization.h"
27
28// We need cuda_runtime.h/hip_runtime.h to ensure that
29// the EIGEN_USING_STD macro works properly on the device side
30#if defined(EIGEN_CUDACC)
31#include <cuda_runtime.h>
32#elif defined(EIGEN_HIPCC)
33#include <hip/hip_runtime.h>
34#endif
35
36#if defined(EIGEN_EXCEPTIONS) || defined(EIGEN_GPU_COMPILE_PHASE)
37#include <new>
38#endif
39
40// Prevent ICC from specializing std::complex operators that silently fail
41// on device. This allows us to use our own device-compatible specializations
42// instead.
43#if EIGEN_COMP_ICC && defined(EIGEN_GPU_COMPILE_PHASE) && !defined(_OVERRIDE_COMPLEX_SPECIALIZATION_)
44#define _OVERRIDE_COMPLEX_SPECIALIZATION_ 1
45#endif
46#include <complex>
47
48// this include file manages BLAS and MKL related macros
49// and inclusion of their respective header files
50#include "src/Core/util/MKL_support.h"
51#include "src/Core/util/AOCL_Support.h"
52
53// EIGEN_HAS_GPU_FP16 is defined in Macros.h when compiling with CUDA or HIP (excluding SPIR-V).
54// TODO: Remove EIGEN_HAS_GPU_BF16 similarly once HIP bf16 guards are cleaned up.
55
56#if defined(EIGEN_HAS_CUDA_BF16) || defined(EIGEN_HAS_HIP_BF16)
57#define EIGEN_HAS_GPU_BF16
58#endif
59
60#if (defined _OPENMP) && (!defined EIGEN_DONT_PARALLELIZE)
61#define EIGEN_HAS_OPENMP
62#endif
63
64#ifdef EIGEN_HAS_OPENMP
65#include <atomic>
66#include <omp.h>
67#endif
68
69#if !EIGEN_COMP_ARM
70#define EIGEN_HAS_ERRNO
71#endif
72
73#ifdef EIGEN_HAS_ERRNO
74#include <cerrno>
75#endif
76#include <cstddef>
77#include <cstdlib>
78#include <cmath>
79#include <functional>
80#ifndef EIGEN_NO_IO
81#include <sstream>
82#include <iosfwd>
83#endif
84#include <cstring>
85#include <string>
86#include <limits>
87#include <climits> // for CHAR_BIT
88// for min/max:
89#include <algorithm>
90
91#include <array>
92#include <memory>
93#include <vector>
94
95// for std::is_nothrow_move_assignable
96#include <type_traits>
97
98// for std::move, std::forward, std::declval
99#include <utility>
100
101// for std::this_thread::yield().
102#if !defined(EIGEN_USE_BLAS) && (defined(EIGEN_HAS_OPENMP) || defined(EIGEN_GEMM_THREADPOOL))
103#include <thread>
104#endif
105
106// for __cpp_lib feature test macros
107#if defined(__has_include) && __has_include(<version>)
108#include <version>
109#endif
110
111// for std::bit_cast()
112#if defined(__cpp_lib_bit_cast) && __cpp_lib_bit_cast >= 201806L
113#include <bit>
114#endif
115
116// for outputting debug info
117#ifdef EIGEN_DEBUG_ASSIGN
118#include <iostream>
119#endif
120
121// required for __cpuid, needs to be included after cmath
122// also required for _BitScanReverse on Windows on ARM
123#if EIGEN_COMP_MSVC && (EIGEN_ARCH_i386_OR_x86_64 || EIGEN_ARCH_ARM64)
124#include <intrin.h>
125#endif
126
127// Required for querying cache sizes on Linux and macOS.
128#if EIGEN_OS_LINUX
129#if !defined(EIGEN_NO_CPU_CACHE_SYSFS)
130#include <cstdio>
131#include <fcntl.h>
132#include <sched.h>
133#endif
134#include <unistd.h>
135#elif EIGEN_OS_MAC
136#include <sys/types.h>
137#include <sys/sysctl.h>
138#endif
139
140#if defined(EIGEN_USE_SYCL)
141#undef min
142#undef max
143#undef isnan
144#undef isinf
145#undef isfinite
146#include <CL/sycl.hpp>
147#include <map>
148#include <thread>
149#ifndef EIGEN_SYCL_LOCAL_THREAD_DIM0
150#define EIGEN_SYCL_LOCAL_THREAD_DIM0 16
151#endif
152#ifndef EIGEN_SYCL_LOCAL_THREAD_DIM1
153#define EIGEN_SYCL_LOCAL_THREAD_DIM1 16
154#endif
155#endif
156
157namespace Eigen {
158
159using std::ptrdiff_t;
160using std::size_t;
161
162} // namespace Eigen
163
173
174#ifdef EIGEN_USE_LAPACKE
175#ifdef EIGEN_USE_MKL
176#include "mkl_lapacke.h"
177#elif defined(EIGEN_LAPACKE_SYSTEM)
178#include <lapacke.h>
179#else
180#include "src/LAPACKESupport/lapacke.h"
181#endif
182#endif
183
184// IWYU pragma: begin_exports
185// Device overloads of the std::complex operators. They must precede every template that applies an operator to a
186// dependent Scalar; see the header.
187#ifdef EIGEN_GPUCC
188#include "src/Core/arch/GPU/Complex.h"
189#endif
190#include "src/Core/util/Constants.h"
191#include "src/Core/util/Meta.h"
192#include "src/Core/util/Assert.h"
193#include "src/Core/util/ForwardDeclarations.h"
194#include "src/Core/util/StaticAssert.h"
195#include "src/Core/util/XprHelper.h"
196#include "src/Core/util/Memory.h"
197#include "src/Core/util/IntegralConstant.h"
198#include "src/Core/util/Serializer.h"
199#include "src/Core/util/SymbolicIndex.h"
200#include "src/Core/util/EmulateArray.h"
201#include "src/Core/util/MoreMeta.h"
202#include "src/Core/util/LruCache.h"
203
204#include "src/Core/NumTraits.h"
205#include "src/Core/MathFunctions.h"
206#include "src/Core/RandomImpl.h"
207#include "src/Core/GenericPacketMath.h"
208#include "src/Core/MathFunctionsImpl.h"
209#include "src/Core/arch/Default/ConjHelper.h"
210// Generic half float support
211#include "src/Core/arch/Default/Half.h"
212#include "src/Core/arch/Default/BFloat16.h"
213#include "src/Core/arch/Default/GenericPacketMathFunctionsFwd.h"
214
215#if defined(EIGEN_VECTORIZE_GENERIC) && !defined(EIGEN_DONT_VECTORIZE)
216#include "src/Core/arch/clang/PacketMath.h"
217#include "src/Core/arch/clang/TypeCasting.h"
218#include "src/Core/arch/clang/Complex.h"
219#include "src/Core/arch/clang/Reductions.h"
220#include "src/Core/arch/clang/MathFunctions.h"
221#else
222#if defined EIGEN_VECTORIZE_AVX512
223#include "src/Core/arch/SSE/PacketMath.h"
224#include "src/Core/arch/SSE/Reductions.h"
225#include "src/Core/arch/AVX/PacketMath.h"
226#include "src/Core/arch/AVX/Reductions.h"
227#include "src/Core/arch/AVX512/PacketMath.h"
228#include "src/Core/arch/AVX512/Reductions.h"
229#if defined EIGEN_VECTORIZE_AVX512FP16
230#include "src/Core/arch/AVX512/PacketMathFP16.h"
231#endif
232#include "src/Core/arch/SSE/TypeCasting.h"
233#include "src/Core/arch/AVX/TypeCasting.h"
234#include "src/Core/arch/AVX512/TypeCasting.h"
235#if defined EIGEN_VECTORIZE_AVX512FP16
236#include "src/Core/arch/AVX512/TypeCastingFP16.h"
237#endif
238#include "src/Core/arch/SSE/Complex.h"
239#include "src/Core/arch/AVX/Complex.h"
240#include "src/Core/arch/AVX512/Complex.h"
241#include "src/Core/arch/SSE/MathFunctions.h"
242#include "src/Core/arch/AVX/MathFunctions.h"
243#include "src/Core/arch/AVX512/MathFunctions.h"
244#if defined EIGEN_VECTORIZE_AVX512FP16
245#include "src/Core/arch/AVX512/MathFunctionsFP16.h"
246#endif
247#include "src/Core/arch/AVX512/TrsmKernel.h"
248#elif defined EIGEN_VECTORIZE_AVX
249// Use AVX for floats and doubles, SSE for integers
250#include "src/Core/arch/SSE/PacketMath.h"
251#include "src/Core/arch/SSE/Reductions.h"
252#include "src/Core/arch/SSE/TypeCasting.h"
253#include "src/Core/arch/SSE/Complex.h"
254#include "src/Core/arch/AVX/PacketMath.h"
255#include "src/Core/arch/AVX/Reductions.h"
256#include "src/Core/arch/AVX/TypeCasting.h"
257#include "src/Core/arch/AVX/Complex.h"
258#include "src/Core/arch/SSE/MathFunctions.h"
259#include "src/Core/arch/AVX/MathFunctions.h"
260#elif defined EIGEN_VECTORIZE_SSE
261#include "src/Core/arch/SSE/PacketMath.h"
262#include "src/Core/arch/SSE/Reductions.h"
263#include "src/Core/arch/SSE/TypeCasting.h"
264#include "src/Core/arch/SSE/MathFunctions.h"
265#include "src/Core/arch/SSE/Complex.h"
266#endif
267
268#if defined(EIGEN_VECTORIZE_ALTIVEC) || defined(EIGEN_VECTORIZE_VSX)
269#include "src/Core/arch/AltiVec/PacketMath.h"
270#include "src/Core/arch/AltiVec/TypeCasting.h"
271#include "src/Core/arch/AltiVec/MathFunctions.h"
272#include "src/Core/arch/AltiVec/Complex.h"
273#elif defined EIGEN_VECTORIZE_NEON
274#include "src/Core/arch/NEON/PacketMath.h"
275#include "src/Core/arch/NEON/TypeCasting.h"
276#include "src/Core/arch/NEON/MathFunctions.h"
277#include "src/Core/arch/NEON/Complex.h"
278#elif defined EIGEN_VECTORIZE_SME
279// Keep NEON packet types outside the specialized streaming kernels.
280#include "src/Core/arch/NEON/PacketMath.h"
281#include "src/Core/arch/NEON/TypeCasting.h"
282#include "src/Core/arch/NEON/MathFunctions.h"
283#include "src/Core/arch/NEON/Complex.h"
284#include "src/Core/arch/SME/PacketMath.h"
285#elif defined EIGEN_VECTORIZE_LSX
286#include "src/Core/arch/LSX/PacketMath.h"
287#include "src/Core/arch/LSX/TypeCasting.h"
288#include "src/Core/arch/LSX/MathFunctions.h"
289#include "src/Core/arch/LSX/Complex.h"
290#elif defined EIGEN_VECTORIZE_SVE
291#include "src/Core/arch/SVE/PacketMath.h"
292#include "src/Core/arch/SVE/TypeCasting.h"
293#include "src/Core/arch/SVE/MathFunctions.h"
294#include "src/Core/arch/SVE/Complex.h"
295#elif defined EIGEN_VECTORIZE_RVV10
296#include "src/Core/arch/RVV10/PacketMathDecl.h"
297#include "src/Core/arch/RVV10/PacketMath.h"
298#include "src/Core/arch/RVV10/PacketMath2.h"
299#include "src/Core/arch/RVV10/PacketMath4.h"
300#include "src/Core/arch/RVV10/TypeCasting.h"
301#include "src/Core/arch/RVV10/MathFunctions.h"
302#if defined EIGEN_VECTORIZE_RVV10FP16
303#include "src/Core/arch/RVV10/PacketMathFP16.h"
304#endif
305#if defined EIGEN_VECTORIZE_RVV10BF16
306#include "src/Core/arch/RVV10/PacketMathBF16.h"
307#endif
308#if EIGEN_RISCV64_DEFAULT_LMUL == 1
309#include "src/Core/arch/RVV10/Complex.h"
310#include "src/Core/arch/RVV10/Complex2.h"
311#endif
312#elif defined EIGEN_VECTORIZE_ZVECTOR
313#include "src/Core/arch/ZVector/PacketMath.h"
314#include "src/Core/arch/ZVector/MathFunctions.h"
315#include "src/Core/arch/ZVector/Complex.h"
316#elif defined EIGEN_VECTORIZE_MSA
317#include "src/Core/arch/MSA/PacketMath.h"
318#include "src/Core/arch/MSA/MathFunctions.h"
319#include "src/Core/arch/MSA/Complex.h"
320#elif defined EIGEN_VECTORIZE_HVX
321#include "src/Core/arch/HVX/PacketMath.h"
322#endif
323
324#if defined EIGEN_VECTORIZE_GPU
325#include "src/Core/arch/GPU/PacketMath.h"
326#include "src/Core/arch/GPU/MathFunctions.h"
327#include "src/Core/arch/GPU/TypeCasting.h"
328#endif
329
330#if defined(EIGEN_USE_SYCL)
331#include "src/Core/arch/SYCL/InteropHeaders.h"
332#if !defined(EIGEN_DONT_VECTORIZE_SYCL)
333#include "src/Core/arch/SYCL/PacketMath.h"
334#include "src/Core/arch/SYCL/MathFunctions.h"
335#include "src/Core/arch/SYCL/TypeCasting.h"
336#endif
337#endif
338
339#endif // #ifndef EIGEN_VECTORIZE_GENERIC
340
341#include "src/Core/arch/Default/Settings.h"
342// This file provides generic implementations valid for scalar as well
343#include "src/Core/arch/Default/GenericPacketMathFunctions.h"
344
345#include "src/Core/functors/TernaryFunctors.h"
346#include "src/Core/functors/BinaryFunctors.h"
347#include "src/Core/functors/UnaryFunctors.h"
348#include "src/Core/functors/NullaryFunctors.h"
349#include "src/Core/functors/StlFunctors.h"
350#include "src/Core/functors/AssignmentFunctors.h"
351
352// Specializations of vectorized activation functions for NEON.
353#ifdef EIGEN_VECTORIZE_NEON
354#include "src/Core/arch/NEON/UnaryFunctors.h"
355#endif
356
357#include "src/Core/util/IndexedViewHelper.h"
358#include "src/Core/util/ReshapedHelper.h"
359#include "src/Core/ArithmeticSequence.h"
360#ifndef EIGEN_NO_IO
361#include "src/Core/IO.h"
362#endif
363#include "src/Core/DenseCoeffsBase.h"
364#include "src/Core/DenseBase.h"
365#include "src/Core/MatrixBase.h"
366#include "src/Core/EigenBase.h"
367
368#include "src/Core/Product.h"
369#include "src/Core/CoreEvaluators.h"
370#include "src/Core/AssignEvaluator.h"
371#include "src/Core/RealView.h"
372#include "src/Core/Assign.h"
373
374#include "src/Core/ArrayBase.h"
375#include "src/Core/util/BlasUtil.h"
376#include "src/Core/DenseStorage.h"
377#include "src/Core/NestByValue.h"
378
379#include "src/Core/ReturnByValue.h"
380#include "src/Core/NoAlias.h"
381#include "src/Core/PlainObjectBase.h"
382#include "src/Core/Matrix.h"
383#include "src/Core/Array.h"
384#include "src/Core/StructuredBindings.h"
385#include "src/Core/Fill.h"
386#include "src/Core/CwiseTernaryOp.h"
387#include "src/Core/CwiseBinaryOp.h"
388#include "src/Core/CwiseUnaryOp.h"
389#include "src/Core/CwiseNullaryOp.h"
390#include "src/Core/CwiseUnaryView.h"
391#include "src/Core/SelfCwiseBinaryOp.h"
392#include "src/Core/InnerProduct.h"
393#include "src/Core/SafeScaling.h"
394#include "src/Core/Dot.h"
395#include "src/Core/StableNorm.h"
396#include "src/Core/Stride.h"
397#include "src/Core/MapBase.h"
398#include "src/Core/Map.h"
399#include "src/Core/Ref.h"
400#include "src/Core/Block.h"
401#include "src/Core/VectorBlock.h"
402#include "src/Core/IndexedView.h"
403#include "src/Core/Reshaped.h"
404#include "src/Core/Transpose.h"
405#include "src/Core/DiagonalMatrix.h"
406#include "src/Core/Diagonal.h"
407#include "src/Core/DiagonalProduct.h"
408#include "src/Core/SkewSymmetricMatrix3.h"
409#include "src/Core/Redux.h"
410#include "src/Core/Visitor.h"
411#include "src/Core/FindCoeff.h"
412#include "src/Core/ApproxComparisons.h"
413#include "src/Core/Swap.h"
414#include "src/Core/CommaInitializer.h"
415#include "src/Core/GeneralProduct.h"
416#include "src/Core/Solve.h"
417#include "src/Core/Inverse.h"
418#include "src/Core/SolverBase.h"
419#include "src/Core/PermutationMatrix.h"
420#include "src/Core/Transpositions.h"
421#include "src/Core/TriangularMatrix.h"
422#include "src/Core/MatrixNorms.h"
423#include "src/Core/SelfAdjointView.h"
424#include "src/Core/products/GeneralBlockPanelKernel.h"
425#include "src/Core/DeviceWrapper.h"
426#ifdef EIGEN_GEMM_THREADPOOL
427#include "ThreadPool"
428#endif
429#include "src/Core/products/Parallelizer.h"
430#include "src/Core/ProductEvaluators.h"
431#include "src/Core/ScaledPermutationMatrix.h"
432#include "src/Core/products/GeneralMatrixVector.h"
433#include "src/Core/products/GeneralMatrixMatrix.h"
434#include "src/Core/SolveTriangular.h"
435#include "src/Core/products/GeneralMatrixMatrixTriangular.h"
436#include "src/Core/products/SelfadjointMatrixVector.h"
437#include "src/Core/products/SelfadjointMatrixMatrix.h"
438#include "src/Core/products/SelfadjointProduct.h"
439#include "src/Core/products/SelfadjointRank2Update.h"
440#include "src/Core/products/TriangularMatrixVector.h"
441#include "src/Core/products/TriangularMatrixMatrix.h"
442#include "src/Core/products/TriangularSolverMatrix.h"
443#include "src/Core/products/TriangularSolverVector.h"
444#include "src/Core/TriangularInPlace.h"
445#include "src/Core/BandMatrix.h"
446#include "src/Core/CoreIterators.h"
447#include "src/Core/ConditionEstimator.h"
448
449#if !defined(EIGEN_VECTORIZE_GENERIC)
450#if defined(EIGEN_VECTORIZE_VSX)
451#include "src/Core/arch/AltiVec/MatrixProduct.h"
452#elif defined EIGEN_VECTORIZE_NEON
453#include "src/Core/arch/NEON/GeneralBlockPanelKernel.h"
454#elif defined EIGEN_VECTORIZE_SVE
455#include "src/Core/arch/SVE/GeneralBlockPanelKernel.h"
456#elif defined EIGEN_VECTORIZE_SME
457#include "src/Core/arch/SME/GeneralBlockPanelKernel.h"
458#include "src/Core/arch/SME/VectorKernels.h"
459#elif defined EIGEN_VECTORIZE_LSX
460#include "src/Core/arch/LSX/GeneralBlockPanelKernel.h"
461#elif defined EIGEN_VECTORIZE_RVV10
462#include "src/Core/arch/RVV10/GeneralBlockPanelKernel.h"
463#endif
464
465#if defined(EIGEN_VECTORIZE_AVX512)
466#include "src/Core/arch/AVX512/GemmKernel.h"
467#endif
468#endif
469
470#include "src/Core/Select.h"
471#include "src/Core/VectorwiseOp.h"
472#include "src/Core/PartialReduxEvaluator.h"
473#include "src/Core/Random.h"
474#include "src/Core/Replicate.h"
475#include "src/Core/ConcatOp.h"
476#include "src/Core/Reverse.h"
477#include "src/Core/ArrayWrapper.h"
478#include "src/Core/StlIterators.h"
479
480#ifdef EIGEN_USE_BLAS
481#include "src/Core/products/GeneralMatrixMatrix_BLAS.h"
482#include "src/Core/products/GeneralMatrixVector_BLAS.h"
483#include "src/Core/products/GeneralMatrixMatrixTriangular_BLAS.h"
484#include "src/Core/products/SelfadjointMatrixMatrix_BLAS.h"
485#include "src/Core/products/SelfadjointMatrixVector_BLAS.h"
486#include "src/Core/products/TriangularMatrixMatrix_BLAS.h"
487#include "src/Core/products/TriangularMatrixVector_BLAS.h"
488#include "src/Core/products/TriangularSolverMatrix_BLAS.h"
489#endif // EIGEN_USE_BLAS
490
491#ifdef EIGEN_USE_MKL_VML
492#include "src/Core/Assign_MKL.h"
493#endif
494
495#ifdef EIGEN_USE_AOCL_VML
496#include "src/Core/Assign_AOCL.h"
497#endif
498
499#include "src/Core/GlobalFunctions.h"
500// IWYU pragma: end_exports
501
502#include "src/Core/util/ReenableStupidWarnings.h"
503
504#endif // EIGEN_CORE_MODULE_H