Eigen
5.0.0-dev
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 std::bit_cast()
110
#if defined(__cpp_lib_bit_cast) && __cpp_lib_bit_cast >= 201806L
111
#include <bit>
112
#endif
113
114
// for outputting debug info
115
#ifdef EIGEN_DEBUG_ASSIGN
116
#include <iostream>
117
#endif
118
119
// required for __cpuid, needs to be included after cmath
120
// also required for _BitScanReverse on Windows on ARM
121
#if EIGEN_COMP_MSVC && (EIGEN_ARCH_i386_OR_x86_64 || EIGEN_ARCH_ARM64) && !EIGEN_OS_WINCE
122
#include <intrin.h>
123
#endif
124
125
#if defined(EIGEN_USE_SYCL)
126
#undef min
127
#undef max
128
#undef isnan
129
#undef isinf
130
#undef isfinite
131
#include <CL/sycl.hpp>
132
#include <map>
133
#include <thread>
134
#include <utility>
135
#ifndef EIGEN_SYCL_LOCAL_THREAD_DIM0
136
#define EIGEN_SYCL_LOCAL_THREAD_DIM0 16
137
#endif
138
#ifndef EIGEN_SYCL_LOCAL_THREAD_DIM1
139
#define EIGEN_SYCL_LOCAL_THREAD_DIM1 16
140
#endif
141
#endif
142
143
#if defined EIGEN2_SUPPORT_STAGE40_FULL_EIGEN3_STRICTNESS || defined EIGEN2_SUPPORT_STAGE30_FULL_EIGEN3_API || \
144
defined EIGEN2_SUPPORT_STAGE20_RESOLVE_API_CONFLICTS || defined EIGEN2_SUPPORT_STAGE10_FULL_EIGEN2_API || \
145
defined EIGEN2_SUPPORT
146
// This will generate an error message:
147
#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
148
#endif
149
150
namespace
Eigen
{
151
152
// we use size_t frequently and we'll never remember to prepend it with std:: every time just to
153
// ensure QNX/QCC support
154
using
std::size_t;
155
// gcc 4.6.0 wants std:: for ptrdiff_t
156
using
std::ptrdiff_t;
157
158
}
// namespace Eigen
159
169
170
#ifdef EIGEN_USE_LAPACKE
171
#ifdef EIGEN_USE_MKL
172
#include "mkl_lapacke.h"
173
#else
174
#include "src/misc/lapacke.h"
175
#endif
176
#endif
177
178
// IWYU pragma: begin_exports
179
#include "src/Core/util/Constants.h"
180
#include "src/Core/util/Meta.h"
181
#include "src/Core/util/Assert.h"
182
#include "src/Core/util/ForwardDeclarations.h"
183
#include "src/Core/util/StaticAssert.h"
184
#include "src/Core/util/XprHelper.h"
185
#include "src/Core/util/Memory.h"
186
#include "src/Core/util/IntegralConstant.h"
187
#include "src/Core/util/Serializer.h"
188
#include "src/Core/util/SymbolicIndex.h"
189
#include "src/Core/util/EmulateArray.h"
190
#include "src/Core/util/MoreMeta.h"
191
192
#include "src/Core/NumTraits.h"
193
#include "src/Core/MathFunctions.h"
194
#include "src/Core/RandomImpl.h"
195
#include "src/Core/GenericPacketMath.h"
196
#include "src/Core/MathFunctionsImpl.h"
197
#include "src/Core/arch/Default/ConjHelper.h"
198
// Generic half float support
199
#include "src/Core/arch/Default/Half.h"
200
#include "src/Core/arch/Default/BFloat16.h"
201
#include "src/Core/arch/Default/GenericPacketMathFunctionsFwd.h"
202
203
#if defined EIGEN_VECTORIZE_AVX512
204
#include "src/Core/arch/SSE/PacketMath.h"
205
#include "src/Core/arch/SSE/Reductions.h"
206
#include "src/Core/arch/AVX/PacketMath.h"
207
#include "src/Core/arch/AVX/Reductions.h"
208
#include "src/Core/arch/AVX512/PacketMath.h"
209
#include "src/Core/arch/AVX512/Reductions.h"
210
#if defined EIGEN_VECTORIZE_AVX512FP16
211
#include "src/Core/arch/AVX512/PacketMathFP16.h"
212
#endif
213
#include "src/Core/arch/SSE/TypeCasting.h"
214
#include "src/Core/arch/AVX/TypeCasting.h"
215
#include "src/Core/arch/AVX512/TypeCasting.h"
216
#if defined EIGEN_VECTORIZE_AVX512FP16
217
#include "src/Core/arch/AVX512/TypeCastingFP16.h"
218
#endif
219
#include "src/Core/arch/SSE/Complex.h"
220
#include "src/Core/arch/AVX/Complex.h"
221
#include "src/Core/arch/AVX512/Complex.h"
222
#include "src/Core/arch/SSE/MathFunctions.h"
223
#include "src/Core/arch/AVX/MathFunctions.h"
224
#include "src/Core/arch/AVX512/MathFunctions.h"
225
#if defined EIGEN_VECTORIZE_AVX512FP16
226
#include "src/Core/arch/AVX512/MathFunctionsFP16.h"
227
#endif
228
#include "src/Core/arch/AVX512/TrsmKernel.h"
229
#elif defined EIGEN_VECTORIZE_AVX
230
// Use AVX for floats and doubles, SSE for integers
231
#include "src/Core/arch/SSE/PacketMath.h"
232
#include "src/Core/arch/SSE/Reductions.h"
233
#include "src/Core/arch/SSE/TypeCasting.h"
234
#include "src/Core/arch/SSE/Complex.h"
235
#include "src/Core/arch/AVX/PacketMath.h"
236
#include "src/Core/arch/AVX/Reductions.h"
237
#include "src/Core/arch/AVX/TypeCasting.h"
238
#include "src/Core/arch/AVX/Complex.h"
239
#include "src/Core/arch/SSE/MathFunctions.h"
240
#include "src/Core/arch/AVX/MathFunctions.h"
241
#elif defined EIGEN_VECTORIZE_SSE
242
#include "src/Core/arch/SSE/PacketMath.h"
243
#include "src/Core/arch/SSE/Reductions.h"
244
#include "src/Core/arch/SSE/TypeCasting.h"
245
#include "src/Core/arch/SSE/MathFunctions.h"
246
#include "src/Core/arch/SSE/Complex.h"
247
#endif
248
249
#if defined(EIGEN_VECTORIZE_ALTIVEC) || defined(EIGEN_VECTORIZE_VSX)
250
#include "src/Core/arch/AltiVec/PacketMath.h"
251
#include "src/Core/arch/AltiVec/TypeCasting.h"
252
#include "src/Core/arch/AltiVec/MathFunctions.h"
253
#include "src/Core/arch/AltiVec/Complex.h"
254
#elif defined EIGEN_VECTORIZE_NEON
255
#include "src/Core/arch/NEON/PacketMath.h"
256
#include "src/Core/arch/NEON/TypeCasting.h"
257
#include "src/Core/arch/NEON/MathFunctions.h"
258
#include "src/Core/arch/NEON/Complex.h"
259
#elif defined EIGEN_VECTORIZE_LSX
260
#include "src/Core/arch/LSX/PacketMath.h"
261
#include "src/Core/arch/LSX/TypeCasting.h"
262
#include "src/Core/arch/LSX/MathFunctions.h"
263
#include "src/Core/arch/LSX/Complex.h"
264
#elif defined EIGEN_VECTORIZE_SVE
265
#include "src/Core/arch/SVE/PacketMath.h"
266
#include "src/Core/arch/SVE/TypeCasting.h"
267
#include "src/Core/arch/SVE/MathFunctions.h"
268
#elif defined EIGEN_VECTORIZE_ZVECTOR
269
#include "src/Core/arch/ZVector/PacketMath.h"
270
#include "src/Core/arch/ZVector/MathFunctions.h"
271
#include "src/Core/arch/ZVector/Complex.h"
272
#elif defined EIGEN_VECTORIZE_MSA
273
#include "src/Core/arch/MSA/PacketMath.h"
274
#include "src/Core/arch/MSA/MathFunctions.h"
275
#include "src/Core/arch/MSA/Complex.h"
276
#elif defined EIGEN_VECTORIZE_HVX
277
#include "src/Core/arch/HVX/PacketMath.h"
278
#endif
279
280
#if defined EIGEN_VECTORIZE_GPU
281
#include "src/Core/arch/GPU/PacketMath.h"
282
#include "src/Core/arch/GPU/MathFunctions.h"
283
#include "src/Core/arch/GPU/TypeCasting.h"
284
#endif
285
286
#if defined(EIGEN_USE_SYCL)
287
#include "src/Core/arch/SYCL/InteropHeaders.h"
288
#if !defined(EIGEN_DONT_VECTORIZE_SYCL)
289
#include "src/Core/arch/SYCL/PacketMath.h"
290
#include "src/Core/arch/SYCL/MathFunctions.h"
291
#include "src/Core/arch/SYCL/TypeCasting.h"
292
#endif
293
#endif
294
295
#include "src/Core/arch/Default/Settings.h"
296
// This file provides generic implementations valid for scalar as well
297
#include "src/Core/arch/Default/GenericPacketMathFunctions.h"
298
299
#include "src/Core/functors/TernaryFunctors.h"
300
#include "src/Core/functors/BinaryFunctors.h"
301
#include "src/Core/functors/UnaryFunctors.h"
302
#include "src/Core/functors/NullaryFunctors.h"
303
#include "src/Core/functors/StlFunctors.h"
304
#include "src/Core/functors/AssignmentFunctors.h"
305
306
// Specialized functors for GPU.
307
#ifdef EIGEN_GPUCC
308
#include "src/Core/arch/GPU/Complex.h"
309
#endif
310
311
// Specializations of vectorized activation functions for NEON.
312
#ifdef EIGEN_VECTORIZE_NEON
313
#include "src/Core/arch/NEON/UnaryFunctors.h"
314
#endif
315
316
#include "src/Core/util/IndexedViewHelper.h"
317
#include "src/Core/util/ReshapedHelper.h"
318
#include "src/Core/ArithmeticSequence.h"
319
#ifndef EIGEN_NO_IO
320
#include "src/Core/IO.h"
321
#endif
322
#include "src/Core/DenseCoeffsBase.h"
323
#include "src/Core/DenseBase.h"
324
#include "src/Core/MatrixBase.h"
325
#include "src/Core/EigenBase.h"
326
327
#include "src/Core/Product.h"
328
#include "src/Core/CoreEvaluators.h"
329
#include "src/Core/AssignEvaluator.h"
330
#include "src/Core/RealView.h"
331
#include "src/Core/Assign.h"
332
333
#include "src/Core/ArrayBase.h"
334
#include "src/Core/util/BlasUtil.h"
335
#include "src/Core/DenseStorage.h"
336
#include "src/Core/NestByValue.h"
337
338
// #include "src/Core/ForceAlignedAccess.h"
339
340
#include "src/Core/ReturnByValue.h"
341
#include "src/Core/NoAlias.h"
342
#include "src/Core/PlainObjectBase.h"
343
#include "src/Core/Matrix.h"
344
#include "src/Core/Array.h"
345
#include "src/Core/Fill.h"
346
#include "src/Core/CwiseTernaryOp.h"
347
#include "src/Core/CwiseBinaryOp.h"
348
#include "src/Core/CwiseUnaryOp.h"
349
#include "src/Core/CwiseNullaryOp.h"
350
#include "src/Core/CwiseUnaryView.h"
351
#include "src/Core/SelfCwiseBinaryOp.h"
352
#include "src/Core/InnerProduct.h"
353
#include "src/Core/Dot.h"
354
#include "src/Core/StableNorm.h"
355
#include "src/Core/Stride.h"
356
#include "src/Core/MapBase.h"
357
#include "src/Core/Map.h"
358
#include "src/Core/Ref.h"
359
#include "src/Core/Block.h"
360
#include "src/Core/VectorBlock.h"
361
#include "src/Core/IndexedView.h"
362
#include "src/Core/Reshaped.h"
363
#include "src/Core/Transpose.h"
364
#include "src/Core/DiagonalMatrix.h"
365
#include "src/Core/Diagonal.h"
366
#include "src/Core/DiagonalProduct.h"
367
#include "src/Core/SkewSymmetricMatrix3.h"
368
#include "src/Core/Redux.h"
369
#include "src/Core/Visitor.h"
370
#include "src/Core/FindCoeff.h"
371
#include "src/Core/Fuzzy.h"
372
#include "src/Core/Swap.h"
373
#include "src/Core/CommaInitializer.h"
374
#include "src/Core/GeneralProduct.h"
375
#include "src/Core/Solve.h"
376
#include "src/Core/Inverse.h"
377
#include "src/Core/SolverBase.h"
378
#include "src/Core/PermutationMatrix.h"
379
#include "src/Core/Transpositions.h"
380
#include "src/Core/TriangularMatrix.h"
381
#include "src/Core/SelfAdjointView.h"
382
#include "src/Core/products/GeneralBlockPanelKernel.h"
383
#include "src/Core/DeviceWrapper.h"
384
#ifdef EIGEN_GEMM_THREADPOOL
385
#include "ThreadPool"
386
#endif
387
#include "src/Core/products/Parallelizer.h"
388
#include "src/Core/ProductEvaluators.h"
389
#include "src/Core/products/GeneralMatrixVector.h"
390
#include "src/Core/products/GeneralMatrixMatrix.h"
391
#include "src/Core/SolveTriangular.h"
392
#include "src/Core/products/GeneralMatrixMatrixTriangular.h"
393
#include "src/Core/products/SelfadjointMatrixVector.h"
394
#include "src/Core/products/SelfadjointMatrixMatrix.h"
395
#include "src/Core/products/SelfadjointProduct.h"
396
#include "src/Core/products/SelfadjointRank2Update.h"
397
#include "src/Core/products/TriangularMatrixVector.h"
398
#include "src/Core/products/TriangularMatrixMatrix.h"
399
#include "src/Core/products/TriangularSolverMatrix.h"
400
#include "src/Core/products/TriangularSolverVector.h"
401
#include "src/Core/BandMatrix.h"
402
#include "src/Core/CoreIterators.h"
403
#include "src/Core/ConditionEstimator.h"
404
405
#if defined(EIGEN_VECTORIZE_VSX)
406
#include "src/Core/arch/AltiVec/MatrixProduct.h"
407
#elif defined EIGEN_VECTORIZE_NEON
408
#include "src/Core/arch/NEON/GeneralBlockPanelKernel.h"
409
#elif defined EIGEN_VECTORIZE_LSX
410
#include "src/Core/arch/LSX/GeneralBlockPanelKernel.h"
411
#endif
412
413
#if defined(EIGEN_VECTORIZE_AVX512)
414
#include "src/Core/arch/AVX512/GemmKernel.h"
415
#endif
416
417
#include "src/Core/Select.h"
418
#include "src/Core/VectorwiseOp.h"
419
#include "src/Core/PartialReduxEvaluator.h"
420
#include "src/Core/Random.h"
421
#include "src/Core/Replicate.h"
422
#include "src/Core/Reverse.h"
423
#include "src/Core/ArrayWrapper.h"
424
#include "src/Core/StlIterators.h"
425
426
#ifdef EIGEN_USE_BLAS
427
#include "src/Core/products/GeneralMatrixMatrix_BLAS.h"
428
#include "src/Core/products/GeneralMatrixVector_BLAS.h"
429
#include "src/Core/products/GeneralMatrixMatrixTriangular_BLAS.h"
430
#include "src/Core/products/SelfadjointMatrixMatrix_BLAS.h"
431
#include "src/Core/products/SelfadjointMatrixVector_BLAS.h"
432
#include "src/Core/products/TriangularMatrixMatrix_BLAS.h"
433
#include "src/Core/products/TriangularMatrixVector_BLAS.h"
434
#include "src/Core/products/TriangularSolverMatrix_BLAS.h"
435
#endif
// EIGEN_USE_BLAS
436
437
#ifdef EIGEN_USE_MKL_VML
438
#include "src/Core/Assign_MKL.h"
439
#endif
440
441
#include "src/Core/GlobalFunctions.h"
442
// IWYU pragma: end_exports
443
444
#include "src/Core/util/ReenableStupidWarnings.h"
445
446
#endif
// EIGEN_CORE_MODULE_H
Eigen
Namespace containing all symbols from the Eigen library.
Definition
B01_Experimental.dox:1
Eigen
Core
Generated by
1.14.0
1.14.0