Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
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 
15 namespace Eigen {
16 
22 const int Dynamic = -1;
23 
27 const int DynamicIndex = 0xffffff;
28 
31 const int UndefinedIncr = 0xfffffe;
32 
36 const int Infinity = -1;
37 
44 const int HugeCost = 10000;
45 
66 const unsigned int RowMajorBit = 0x1;
67 
70 const unsigned int EvalBeforeNestingBit = 0x2;
71 
75 EIGEN_DEPRECATED
76 const unsigned int EvalBeforeAssigningBit = 0x4; // FIXME deprecated
77 
94 const unsigned int PacketAccessBit = 0x8;
95 
96 #ifdef EIGEN_VECTORIZE
97 
106 #else
107 const unsigned int ActualPacketAccessBit = 0x0;
108 #endif
109 
130 const unsigned int LinearAccessBit = 0x10;
131 
144 const unsigned int LvalueBit = 0x20;
145 
155 const unsigned int DirectAccessBit = 0x40;
156 
167 EIGEN_DEPRECATED const unsigned int AlignedBit = 0x80;
168 
169 const unsigned int NestByRefBit = 0x100;
170 
178 const unsigned int NoPreferredStorageOrderBit = 0x200;
179 
191 const unsigned int CompressedAccessBit = 0x400;
192 
193 
194 // list of flags that are inherited by default
195 const unsigned int HereditaryBits = RowMajorBit
197 
207 enum UpLoType {
209  Lower=0x1,
211  Upper=0x2,
213  UnitDiag=0x4,
215  ZeroDiag=0x8,
228 };
229 
239  AlignedMask=255,
240  Aligned=16,
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 
271 };
272 
275 enum TraversalType {
277  DefaultTraversal,
279  LinearTraversal,
282  InnerVectorizedTraversal,
285  LinearVectorizedTraversal,
288  SliceVectorizedTraversal,
290  InvalidTraversal,
292  AllAtOnceTraversal
293 };
294 
297 enum UnrollingType {
299  NoUnrolling,
301  InnerUnrolling,
304  CompleteUnrolling
305 };
306 
309 enum SpecializedType {
310  Specialized,
311  BuiltIn
312 };
313 
319  ColMajor = 0,
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
326 };
327 
330 enum SideType {
335 };
336 
346 };
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 
360 enum NoChange_t { NoChange };
361 enum Sequential_t { Sequential };
362 enum Default_t { Default };
363 
366 enum AmbiVectorMode {
367  IsDense = 0,
368  IsSparse
369 };
370 
383 };
384 
389  Pivoting = 0x01,
391  NoPivoting = 0x02,
393  ComputeFullU = 0x04,
395  ComputeThinU = 0x08,
397  ComputeFullV = 0x10,
399  ComputeThinV = 0x20,
407  EigVecMask = EigenvaluesOnly | ComputeEigenvectors,
410  Ax_lBx = 0x100,
413  ABx_lx = 0x200,
416  BAx_lx = 0x400,
418  GenEigMask = Ax_lBx | ABx_lx | BAx_lx
419 };
420 
432 };
433 
434 #ifdef Success
435 #error The preprocessor symbol 'Success' is defined, possibly by the X11 header file X.h
436 #endif
437 
442  Success = 0,
450 };
451 
457  Isometry = 0x1,
460  Affine = 0x2,
464  Projective = 0x20
465 };
466 
469 namespace 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 
499 enum ProductImplType
500 { DefaultProduct=0, LazyProduct, AliasFreeProduct, CoeffBasedProductMode, LazyCoeffBasedProductMode, OuterProduct, InnerProduct, GemvProduct, GemmProduct };
501 
504 enum Action {GetAction, SetAction};
505 
507 struct Dense {};
508 
510 struct Sparse {};
511 
513 struct SolverStorage {};
514 
517 
520 
522 struct MatrixXpr {};
523 
525 struct ArrayXpr {};
526 
527 // An evaluator must define its shape. By default, it can be one of the following:
528 struct DenseShape { static std::string debugName() { return "DenseShape"; } };
529 struct SolverShape { static std::string debugName() { return "SolverShape"; } };
530 struct HomogeneousShape { static std::string debugName() { return "HomogeneousShape"; } };
531 struct DiagonalShape { static std::string debugName() { return "DiagonalShape"; } };
532 struct BandShape { static std::string debugName() { return "BandShape"; } };
533 struct TriangularShape { static std::string debugName() { return "TriangularShape"; } };
534 struct SelfAdjointShape { static std::string debugName() { return "SelfAdjointShape"; } };
535 struct PermutationShape { static std::string debugName() { return "PermutationShape"; } };
536 struct TranspositionsShape { static std::string debugName() { return "TranspositionsShape"; } };
537 struct SparseShape { static std::string debugName() { return "SparseShape"; } };
538 
539 namespace internal {
540 
541  // random access iterators based on coeff*() accessors.
542 struct IndexBased {};
543 
544 // evaluator based on iterators to access coefficients.
545 struct IteratorBased {};
546 
550 enum 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
Definition: Constants.h:238
Definition: Constants.h:378
Definition: Constants.h:393
AccessorLevels
Definition: Constants.h:374
Definition: Constants.h:319
const unsigned int CompressedAccessBit
Definition: Constants.h:191
const int HugeCost
Definition: Constants.h:44
Definition: Constants.h:402
Definition: Constants.h:334
Definition: Constants.h:235
Definition: Constants.h:325
Definition: Constants.h:264
Definition: Constants.h:221
Definition: Constants.h:341
Definition: Constants.h:425
EIGEN_DEPRECATED const unsigned int EvalBeforeAssigningBit
Definition: Constants.h:76
Definition: Constants.h:399
const unsigned int DirectAccessBit
Definition: Constants.h:155
Definition: Constants.h:345
const unsigned int LvalueBit
Definition: Constants.h:144
Definition: Constants.h:516
DirectionType
Definition: Constants.h:261
Namespace containing all symbols from the Eigen library.
Definition: Core:141
const int DynamicIndex
Definition: Constants.h:27
Definition: Constants.h:457
Definition: Constants.h:413
Definition: Constants.h:416
Definition: Constants.h:427
Definition: Constants.h:233
const unsigned int RowMajorBit
Definition: Constants.h:66
const unsigned int PacketAccessBit
Definition: Constants.h:94
Definition: Constants.h:236
Definition: Constants.h:464
Definition: Constants.h:410
Definition: Constants.h:522
Definition: Constants.h:234
Definition: Constants.h:376
Definition: Constants.h:462
Definition: Constants.h:323
SideType
Definition: Constants.h:330
Definition: Constants.h:209
Definition: Constants.h:429
Definition: Constants.h:405
TransformTraits
Definition: Constants.h:455
Definition: Constants.h:227
StorageOptions
Definition: Constants.h:317
Definition: Constants.h:213
Definition: Constants.h:237
Definition: Constants.h:444
NaNPropagationOptions
Definition: Constants.h:339
Definition: Constants.h:380
Definition: Constants.h:240
Definition: Constants.h:332
Definition: Constants.h:223
Definition: Constants.h:510
Definition: Constants.h:219
Definition: Constants.h:449
Definition: Constants.h:382
Definition: Constants.h:211
Definition: Constants.h:442
Definition: Constants.h:267
EIGEN_DEPRECATED const unsigned int AlignedBit
Definition: Constants.h:167
Definition: Constants.h:270
Definition: Constants.h:215
Definition: Constants.h:217
Definition: Eigen_Colamd.h:50
AlignmentType
Definition: Constants.h:232
Definition: Constants.h:225
Definition: Constants.h:513
Definition: Constants.h:321
QRPreconditioners
Definition: Constants.h:423
const int UndefinedIncr
Definition: Constants.h:31
Definition: Constants.h:507
Definition: Constants.h:519
Definition: Constants.h:525
DecompositionOptions
Definition: Constants.h:387
UpLoType
Definition: Constants.h:207
const int Dynamic
Definition: Constants.h:22
const unsigned int EvalBeforeNestingBit
Definition: Constants.h:70
Definition: Constants.h:397
Definition: Constants.h:395
const unsigned int ActualPacketAccessBit
Definition: Constants.h:105
Definition: Constants.h:343
ComputationInfo
Definition: Constants.h:440
Definition: Constants.h:460
Definition: Constants.h:446
const unsigned int LinearAccessBit
Definition: Constants.h:130
const int Infinity
Definition: Constants.h:36
const unsigned int NoPreferredStorageOrderBit
Definition: Constants.h:178