Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
 
Loading...
Searching...
No Matches
Constants.h
1// This file is part of Eigen, a lightweight C++ template library
2// for linear algebra.
3//
4// Copyright (C) 2008-2015 Gael Guennebaud <gael.guennebaud@inria.fr>
5// Copyright (C) 2007-2009 Benoit Jacob <jacob.benoit.1@gmail.com>
6// Copyright (C) 2020, Arm Limited and Contributors
7//
8// This Source Code Form is subject to the terms of the Mozilla
9// Public License v. 2.0. If a copy of the MPL was not distributed
10// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
11
12#ifndef EIGEN_CONSTANTS_H
13#define EIGEN_CONSTANTS_H
14
15namespace Eigen {
16
22const int Dynamic = -1;
23
27const int DynamicIndex = 0xffffff;
28
31const int UndefinedIncr = 0xfffffe;
32
36const int Infinity = -1;
37
44const int HugeCost = 10000;
45
66const unsigned int RowMajorBit = 0x1;
67
70const unsigned int EvalBeforeNestingBit = 0x2;
71
75EIGEN_DEPRECATED
76const unsigned int EvalBeforeAssigningBit = 0x4; // FIXME deprecated
77
94const unsigned int PacketAccessBit = 0x8;
95
96#ifdef EIGEN_VECTORIZE
106#else
107const unsigned int ActualPacketAccessBit = 0x0;
108#endif
109
130const unsigned int LinearAccessBit = 0x10;
131
144const unsigned int LvalueBit = 0x20;
145
155const unsigned int DirectAccessBit = 0x40;
156
167EIGEN_DEPRECATED const unsigned int AlignedBit = 0x80;
168
169const unsigned int NestByRefBit = 0x100;
170
178const unsigned int NoPreferredStorageOrderBit = 0x200;
179
191const unsigned int CompressedAccessBit = 0x400;
192
193
194// list of flags that are inherited by default
195const unsigned int HereditaryBits = RowMajorBit
197
209 Lower=0x1,
211 Upper=0x2,
227 Symmetric=0x20
229
239 AlignedMask=255,
241#if EIGEN_MAX_ALIGN_BYTES==128
242 AlignedMax = Aligned128
243#elif EIGEN_MAX_ALIGN_BYTES==64
244 AlignedMax = Aligned64
245#elif EIGEN_MAX_ALIGN_BYTES==32
246 AlignedMax = Aligned32
247#elif EIGEN_MAX_ALIGN_BYTES==16
248 AlignedMax = Aligned16
249#elif EIGEN_MAX_ALIGN_BYTES==8
250 AlignedMax = Aligned8
251#elif EIGEN_MAX_ALIGN_BYTES==0
252 AlignedMax = Unaligned
253#else
254#error Invalid value for EIGEN_MAX_ALIGN_BYTES
255#endif
256};
257
272
275enum TraversalType {
277 DefaultTraversal,
279 LinearTraversal,
282 InnerVectorizedTraversal,
285 LinearVectorizedTraversal,
288 SliceVectorizedTraversal,
290 InvalidTraversal,
292 AllAtOnceTraversal
293};
294
297enum UnrollingType {
299 NoUnrolling,
301 InnerUnrolling,
304 CompleteUnrolling
305};
306
309enum SpecializedType {
310 Specialized,
311 BuiltIn
312};
313
321 RowMajor = 0x1, // it is only a coincidence that this is equal to RowMajorBit -- don't rely on that
323 AutoAlign = 0, // FIXME --- clarify the situation
325 DontAlign = 0x2
327
334 OnTheRight = 2
336
347
348/* the following used to be written as:
349 *
350 * struct NoChange_t {};
351 * namespace {
352 * EIGEN_UNUSED NoChange_t NoChange;
353 * }
354 *
355 * on the ground that it feels dangerous to disambiguate overloaded functions on enum/integer types.
356 * However, this leads to "variable declared but never referenced" warnings on Intel Composer XE,
357 * and we do not know how to get rid of them (bug 450).
358 */
359
360enum NoChange_t { NoChange };
361enum Sequential_t { Sequential };
362enum Default_t { Default };
363
366enum AmbiVectorMode {
367 IsDense = 0,
368 IsSparse
369};
370
384
389 Pivoting = 0x01,
391 NoPivoting = 0x02,
410 Ax_lBx = 0x100,
413 ABx_lx = 0x200,
416 BAx_lx = 0x400,
418 GenEigMask = Ax_lBx | ABx_lx | BAx_lx
419};
420
433
434#ifdef Success
435#error The preprocessor symbol 'Success' is defined, possibly by the X11 header file X.h
436#endif
437
449 InvalidInput = 3
451
457 Isometry = 0x1,
460 Affine = 0x2,
464 Projective = 0x20
466
469namespace Architecture
470{
471 enum Type {
472 Generic = 0x0,
473 SSE = 0x1,
474 AltiVec = 0x2,
475 VSX = 0x3,
476 NEON = 0x4,
477 MSA = 0x5,
478 SVE = 0x6,
479#if defined EIGEN_VECTORIZE_SSE
480 Target = SSE
481#elif defined EIGEN_VECTORIZE_ALTIVEC
482 Target = AltiVec
483#elif defined EIGEN_VECTORIZE_VSX
484 Target = VSX
485#elif defined EIGEN_VECTORIZE_NEON
486 Target = NEON
487#elif defined EIGEN_VECTORIZE_SVE
488 Target = SVE
489#elif defined EIGEN_VECTORIZE_MSA
490 Target = MSA
491#else
492 Target = Generic
493#endif
494 };
495}
496
499enum ProductImplType
500{ DefaultProduct=0, LazyProduct, AliasFreeProduct, CoeffBasedProductMode, LazyCoeffBasedProductMode, OuterProduct, InnerProduct, GemvProduct, GemmProduct };
501
504enum Action {GetAction, SetAction};
505
507struct Dense {};
508
510struct Sparse {};
511
514
517
520
522struct MatrixXpr {};
523
525struct ArrayXpr {};
526
527// An evaluator must define its shape. By default, it can be one of the following:
528struct DenseShape { static std::string debugName() { return "DenseShape"; } };
529struct SolverShape { static std::string debugName() { return "SolverShape"; } };
530struct HomogeneousShape { static std::string debugName() { return "HomogeneousShape"; } };
531struct DiagonalShape { static std::string debugName() { return "DiagonalShape"; } };
532struct BandShape { static std::string debugName() { return "BandShape"; } };
533struct TriangularShape { static std::string debugName() { return "TriangularShape"; } };
534struct SelfAdjointShape { static std::string debugName() { return "SelfAdjointShape"; } };
535struct PermutationShape { static std::string debugName() { return "PermutationShape"; } };
536struct TranspositionsShape { static std::string debugName() { return "TranspositionsShape"; } };
537struct SparseShape { static std::string debugName() { return "SparseShape"; } };
538
539namespace internal {
540
541 // random access iterators based on coeff*() accessors.
542struct IndexBased {};
543
544// evaluator based on iterators to access coefficients.
545struct IteratorBased {};
546
550enum ComparisonName {
551 cmp_EQ = 0,
552 cmp_LT = 1,
553 cmp_LE = 2,
554 cmp_UNORD = 3,
555 cmp_NEQ = 4,
556 cmp_GT = 5,
557 cmp_GE = 6
558};
559} // end namespace internal
560
561} // end namespace Eigen
562
563#endif // EIGEN_CONSTANTS_H
UpLoType
Definition: Constants.h:207
AlignmentType
Definition: Constants.h:232
QRPreconditioners
Definition: Constants.h:423
NaNPropagationOptions
Definition: Constants.h:339
ComputationInfo
Definition: Constants.h:440
AccessorLevels
Definition: Constants.h:374
StorageOptions
Definition: Constants.h:317
SideType
Definition: Constants.h:330
DirectionType
Definition: Constants.h:261
DecompositionOptions
Definition: Constants.h:387
TransformTraits
Definition: Constants.h:455
@ StrictlyLower
Definition: Constants.h:221
@ UnitDiag
Definition: Constants.h:213
@ StrictlyUpper
Definition: Constants.h:223
@ UnitLower
Definition: Constants.h:217
@ ZeroDiag
Definition: Constants.h:215
@ SelfAdjoint
Definition: Constants.h:225
@ Symmetric
Definition: Constants.h:227
@ UnitUpper
Definition: Constants.h:219
@ Lower
Definition: Constants.h:209
@ Upper
Definition: Constants.h:211
@ Aligned64
Definition: Constants.h:237
@ Unaligned
Definition: Constants.h:233
@ Aligned128
Definition: Constants.h:238
@ Aligned32
Definition: Constants.h:236
@ Aligned8
Definition: Constants.h:234
@ Aligned16
Definition: Constants.h:235
@ Aligned
Definition: Constants.h:240
@ NoQRPreconditioner
Definition: Constants.h:425
@ HouseholderQRPreconditioner
Definition: Constants.h:427
@ ColPivHouseholderQRPreconditioner
Definition: Constants.h:429
@ FullPivHouseholderQRPreconditioner
Definition: Constants.h:431
@ PropagateNaN
Definition: Constants.h:343
@ PropagateNumbers
Definition: Constants.h:345
@ PropagateFast
Definition: Constants.h:341
@ NumericalIssue
Definition: Constants.h:444
@ InvalidInput
Definition: Constants.h:449
@ Success
Definition: Constants.h:442
@ NoConvergence
Definition: Constants.h:446
@ DirectAccessors
Definition: Constants.h:380
@ ReadOnlyAccessors
Definition: Constants.h:376
@ WriteAccessors
Definition: Constants.h:378
@ DirectWriteAccessors
Definition: Constants.h:382
@ ColMajor
Definition: Constants.h:319
@ DontAlign
Definition: Constants.h:325
@ RowMajor
Definition: Constants.h:321
@ AutoAlign
Definition: Constants.h:323
@ OnTheLeft
Definition: Constants.h:332
@ OnTheRight
Definition: Constants.h:334
@ BothDirections
Definition: Constants.h:270
@ Horizontal
Definition: Constants.h:267
@ Vertical
Definition: Constants.h:264
@ ComputeFullV
Definition: Constants.h:397
@ ComputeThinV
Definition: Constants.h:399
@ Ax_lBx
Definition: Constants.h:410
@ ComputeEigenvectors
Definition: Constants.h:405
@ BAx_lx
Definition: Constants.h:416
@ ABx_lx
Definition: Constants.h:413
@ ComputeFullU
Definition: Constants.h:393
@ ComputeThinU
Definition: Constants.h:395
@ EigenvaluesOnly
Definition: Constants.h:402
@ Affine
Definition: Constants.h:460
@ Projective
Definition: Constants.h:464
@ AffineCompact
Definition: Constants.h:462
@ Isometry
Definition: Constants.h:457
const unsigned int ActualPacketAccessBit
Definition: Constants.h:105
EIGEN_DEPRECATED const unsigned int EvalBeforeAssigningBit
Definition: Constants.h:76
const unsigned int PacketAccessBit
Definition: Constants.h:94
const unsigned int NoPreferredStorageOrderBit
Definition: Constants.h:178
const unsigned int LinearAccessBit
Definition: Constants.h:130
const unsigned int EvalBeforeNestingBit
Definition: Constants.h:70
const unsigned int DirectAccessBit
Definition: Constants.h:155
EIGEN_DEPRECATED const unsigned int AlignedBit
Definition: Constants.h:167
const unsigned int LvalueBit
Definition: Constants.h:144
const unsigned int RowMajorBit
Definition: Constants.h:66
const unsigned int CompressedAccessBit
Definition: Constants.h:191
Namespace containing all symbols from the Eigen library.
Definition: Core:141
const int UndefinedIncr
Definition: Constants.h:31
const int HugeCost
Definition: Constants.h:44
const int DynamicIndex
Definition: Constants.h:27
const int Infinity
Definition: Constants.h:36
const int Dynamic
Definition: Constants.h:22
Definition: Constants.h:525
Definition: Constants.h:507
Definition: Constants.h:522
Definition: Constants.h:516
Definition: Constants.h:513
Definition: Constants.h:510
Definition: Constants.h:519