Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.3.8
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 //
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_CONSTANTS_H
12 #define EIGEN_CONSTANTS_H
13 
14 namespace Eigen {
15 
21 const int Dynamic = -1;
22 
26 const int DynamicIndex = 0xffffff;
27 
31 const int Infinity = -1;
32 
39 const int HugeCost = 10000;
40 
61 const unsigned int RowMajorBit = 0x1;
62 
65 const unsigned int EvalBeforeNestingBit = 0x2;
66 
70 EIGEN_DEPRECATED
71 const unsigned int EvalBeforeAssigningBit = 0x4; // FIXME deprecated
72 
89 const unsigned int PacketAccessBit = 0x8;
90 
91 #ifdef EIGEN_VECTORIZE
92 
101 #else
102 const unsigned int ActualPacketAccessBit = 0x0;
103 #endif
104 
125 const unsigned int LinearAccessBit = 0x10;
126 
139 const unsigned int LvalueBit = 0x20;
140 
150 const unsigned int DirectAccessBit = 0x40;
151 
162 EIGEN_DEPRECATED const unsigned int AlignedBit = 0x80;
163 
164 const unsigned int NestByRefBit = 0x100;
165 
173 const unsigned int NoPreferredStorageOrderBit = 0x200;
174 
186 const unsigned int CompressedAccessBit = 0x400;
187 
188 
189 // list of flags that are inherited by default
190 const unsigned int HereditaryBits = RowMajorBit
192 
202 enum UpLoType {
204  Lower=0x1,
206  Upper=0x2,
208  UnitDiag=0x4,
210  ZeroDiag=0x8,
223 };
224 
234  AlignedMask=255,
235  Aligned=16,
236 #if EIGEN_MAX_ALIGN_BYTES==128
237  AlignedMax = Aligned128
238 #elif EIGEN_MAX_ALIGN_BYTES==64
239  AlignedMax = Aligned64
240 #elif EIGEN_MAX_ALIGN_BYTES==32
241  AlignedMax = Aligned32
242 #elif EIGEN_MAX_ALIGN_BYTES==16
243  AlignedMax = Aligned16
244 #elif EIGEN_MAX_ALIGN_BYTES==8
245  AlignedMax = Aligned8
246 #elif EIGEN_MAX_ALIGN_BYTES==0
247  AlignedMax = Unaligned
248 #else
249 #error Invalid value for EIGEN_MAX_ALIGN_BYTES
250 #endif
251 };
252 
255 // FIXME after the corner() API change, this was not needed anymore, except by AlignedBox
256 // TODO: find out what to do with that. Adapt the AlignedBox API ?
257 enum CornerType { TopLeft, TopRight, BottomLeft, BottomRight };
258 
272 };
273 
276 enum TraversalType {
278  DefaultTraversal,
280  LinearTraversal,
283  InnerVectorizedTraversal,
286  LinearVectorizedTraversal,
289  SliceVectorizedTraversal,
291  InvalidTraversal,
293  AllAtOnceTraversal
294 };
295 
298 enum UnrollingType {
300  NoUnrolling,
302  InnerUnrolling,
305  CompleteUnrolling
306 };
307 
310 enum SpecializedType {
311  Specialized,
312  BuiltIn
313 };
314 
320  ColMajor = 0,
322  RowMajor = 0x1, // it is only a coincidence that this is equal to RowMajorBit -- don't rely on that
324  AutoAlign = 0, // FIXME --- clarify the situation
326  DontAlign = 0x2
327 };
328 
331 enum SideType {
333  OnTheLeft = 1,
336 };
337 
338 /* the following used to be written as:
339  *
340  * struct NoChange_t {};
341  * namespace {
342  * EIGEN_UNUSED NoChange_t NoChange;
343  * }
344  *
345  * on the ground that it feels dangerous to disambiguate overloaded functions on enum/integer types.
346  * However, this leads to "variable declared but never referenced" warnings on Intel Composer XE,
347  * and we do not know how to get rid of them (bug 450).
348  */
349 
350 enum NoChange_t { NoChange };
351 enum Sequential_t { Sequential };
352 enum Default_t { Default };
353 
356 enum AmbiVectorMode {
357  IsDense = 0,
358  IsSparse
359 };
360 
373 };
374 
379  Pivoting = 0x01,
381  NoPivoting = 0x02,
383  ComputeFullU = 0x04,
385  ComputeThinU = 0x08,
387  ComputeFullV = 0x10,
389  ComputeThinV = 0x20,
397  EigVecMask = EigenvaluesOnly | ComputeEigenvectors,
400  Ax_lBx = 0x100,
403  ABx_lx = 0x200,
406  BAx_lx = 0x400,
408  GenEigMask = Ax_lBx | ABx_lx | BAx_lx
409 };
410 
422 };
423 
424 #ifdef Success
425 #error The preprocessor symbol 'Success' is defined, possibly by the X11 header file X.h
426 #endif
427 
432  Success = 0,
440 };
441 
447  Isometry = 0x1,
450  Affine = 0x2,
454  Projective = 0x20
455 };
456 
459 namespace Architecture
460 {
461  enum Type {
462  Generic = 0x0,
463  SSE = 0x1,
464  AltiVec = 0x2,
465  VSX = 0x3,
466  NEON = 0x4,
467 #if defined EIGEN_VECTORIZE_SSE
468  Target = SSE
469 #elif defined EIGEN_VECTORIZE_ALTIVEC
470  Target = AltiVec
471 #elif defined EIGEN_VECTORIZE_VSX
472  Target = VSX
473 #elif defined EIGEN_VECTORIZE_NEON
474  Target = NEON
475 #else
476  Target = Generic
477 #endif
478  };
479 }
480 
483 enum ProductImplType
484 { DefaultProduct=0, LazyProduct, AliasFreeProduct, CoeffBasedProductMode, LazyCoeffBasedProductMode, OuterProduct, InnerProduct, GemvProduct, GemmProduct };
485 
488 enum Action {GetAction, SetAction};
489 
491 struct Dense {};
492 
494 struct Sparse {};
495 
497 struct SolverStorage {};
498 
501 
504 
506 struct MatrixXpr {};
507 
509 struct ArrayXpr {};
510 
511 // An evaluator must define its shape. By default, it can be one of the following:
512 struct DenseShape { static std::string debugName() { return "DenseShape"; } };
513 struct SolverShape { static std::string debugName() { return "SolverShape"; } };
514 struct HomogeneousShape { static std::string debugName() { return "HomogeneousShape"; } };
515 struct DiagonalShape { static std::string debugName() { return "DiagonalShape"; } };
516 struct BandShape { static std::string debugName() { return "BandShape"; } };
517 struct TriangularShape { static std::string debugName() { return "TriangularShape"; } };
518 struct SelfAdjointShape { static std::string debugName() { return "SelfAdjointShape"; } };
519 struct PermutationShape { static std::string debugName() { return "PermutationShape"; } };
520 struct TranspositionsShape { static std::string debugName() { return "TranspositionsShape"; } };
521 struct SparseShape { static std::string debugName() { return "SparseShape"; } };
522 
523 namespace internal {
524 
525  // random access iterators based on coeff*() accessors.
526 struct IndexBased {};
527 
528 // evaluator based on iterators to access coefficients.
529 struct IteratorBased {};
530 
534 enum ComparisonName {
535  cmp_EQ = 0,
536  cmp_LT = 1,
537  cmp_LE = 2,
538  cmp_UNORD = 3,
539  cmp_NEQ = 4,
540  cmp_GT = 5,
541  cmp_GE = 6
542 };
543 } // end namespace internal
544 
545 } // end namespace Eigen
546 
547 #endif // EIGEN_CONSTANTS_H
Eigen::ActualPacketAccessBit
const unsigned int ActualPacketAccessBit
Definition: Constants.h:100
Eigen::NumericalIssue
@ NumericalIssue
Definition: Constants.h:434
Eigen::HugeCost
const int HugeCost
Definition: Constants.h:39
Eigen::MatrixXpr
Definition: Constants.h:506
Eigen::FullPivHouseholderQRPreconditioner
@ FullPivHouseholderQRPreconditioner
Definition: Constants.h:421
Eigen::Symmetric
@ Symmetric
Definition: Constants.h:222
Eigen
Namespace containing all symbols from the Eigen library.
Definition: Core:309
Eigen::BAx_lx
@ BAx_lx
Definition: Constants.h:406
Eigen::ComputeFullV
@ ComputeFullV
Definition: Constants.h:387
Eigen::UpLoType
UpLoType
Definition: Constants.h:202
Eigen::Affine
@ Affine
Definition: Constants.h:450
Eigen::Horizontal
@ Horizontal
Definition: Constants.h:268
Eigen::Sparse
Definition: Constants.h:494
Eigen::Unaligned
@ Unaligned
Definition: Constants.h:228
Eigen::RowMajorBit
const unsigned int RowMajorBit
Definition: Constants.h:61
Eigen::SideType
SideType
Definition: Constants.h:331
Eigen::UnitUpper
@ UnitUpper
Definition: Constants.h:214
Eigen::CompressedAccessBit
const unsigned int CompressedAccessBit
Definition: Constants.h:186
Eigen::Upper
@ Upper
Definition: Constants.h:206
Eigen::ComputeFullU
@ ComputeFullU
Definition: Constants.h:383
Eigen::Success
@ Success
Definition: Constants.h:432
Eigen::DirectionType
DirectionType
Definition: Constants.h:262
Eigen::RowMajor
@ RowMajor
Definition: Constants.h:322
Eigen::ColPivHouseholderQRPreconditioner
@ ColPivHouseholderQRPreconditioner
Definition: Constants.h:419
Eigen::ComputeEigenvectors
@ ComputeEigenvectors
Definition: Constants.h:395
Eigen::DontAlign
@ DontAlign
Definition: Constants.h:326
Eigen::DirectAccessBit
const unsigned int DirectAccessBit
Definition: Constants.h:150
Eigen::StorageOptions
StorageOptions
Definition: Constants.h:318
Eigen::PacketAccessBit
const unsigned int PacketAccessBit
Definition: Constants.h:89
Eigen::OnTheLeft
@ OnTheLeft
Definition: Constants.h:333
Eigen::ArrayXpr
Definition: Constants.h:509
Eigen::StrictlyUpper
@ StrictlyUpper
Definition: Constants.h:218
Eigen::DirectAccessors
@ DirectAccessors
Definition: Constants.h:370
Eigen::NoConvergence
@ NoConvergence
Definition: Constants.h:436
Eigen::LvalueBit
const unsigned int LvalueBit
Definition: Constants.h:139
Eigen::Isometry
@ Isometry
Definition: Constants.h:447
Eigen::SolverStorage
Definition: Constants.h:497
Eigen::ComputeThinU
@ ComputeThinU
Definition: Constants.h:385
Eigen::TransformTraits
TransformTraits
Definition: Constants.h:445
Eigen::ZeroDiag
@ ZeroDiag
Definition: Constants.h:210
Eigen::Dynamic
const int Dynamic
Definition: Constants.h:21
Eigen::HouseholderQRPreconditioner
@ HouseholderQRPreconditioner
Definition: Constants.h:417
Eigen::Ax_lBx
@ Ax_lBx
Definition: Constants.h:400
Eigen::Projective
@ Projective
Definition: Constants.h:454
Eigen::StrictlyLower
@ StrictlyLower
Definition: Constants.h:216
Eigen::EigenvaluesOnly
@ EigenvaluesOnly
Definition: Constants.h:392
Eigen::Aligned8
@ Aligned8
Definition: Constants.h:229
Eigen::AutoAlign
@ AutoAlign
Definition: Constants.h:324
Eigen::Lower
@ Lower
Definition: Constants.h:204
Eigen::Vertical
@ Vertical
Definition: Constants.h:265
Eigen::OnTheRight
@ OnTheRight
Definition: Constants.h:335
Eigen::Aligned128
@ Aligned128
Definition: Constants.h:233
Eigen::EvalBeforeAssigningBit
const EIGEN_DEPRECATED unsigned int EvalBeforeAssigningBit
Definition: Constants.h:71
Eigen::NoQRPreconditioner
@ NoQRPreconditioner
Definition: Constants.h:415
Eigen::ReadOnlyAccessors
@ ReadOnlyAccessors
Definition: Constants.h:366
Eigen::Aligned16
@ Aligned16
Definition: Constants.h:230
Eigen::LinearAccessBit
const unsigned int LinearAccessBit
Definition: Constants.h:125
Eigen::AlignedBit
const EIGEN_DEPRECATED unsigned int AlignedBit
Definition: Constants.h:162
Eigen::DecompositionOptions
DecompositionOptions
Definition: Constants.h:377
Eigen::ComputeThinV
@ ComputeThinV
Definition: Constants.h:389
Eigen::PermutationStorage
Definition: Constants.h:500
Eigen::AlignmentType
AlignmentType
Definition: Constants.h:227
Eigen::QRPreconditioners
QRPreconditioners
Definition: Constants.h:413
Eigen::DirectWriteAccessors
@ DirectWriteAccessors
Definition: Constants.h:372
Eigen::TranspositionsStorage
Definition: Constants.h:503
Eigen::ABx_lx
@ ABx_lx
Definition: Constants.h:403
Eigen::BothDirections
@ BothDirections
Definition: Constants.h:271
Eigen::CornerType
CornerType
Definition: Constants.h:257
Eigen::InvalidInput
@ InvalidInput
Definition: Constants.h:439
Eigen::DynamicIndex
const int DynamicIndex
Definition: Constants.h:26
Eigen::AffineCompact
@ AffineCompact
Definition: Constants.h:452
Eigen::ColMajor
@ ColMajor
Definition: Constants.h:320
Eigen::NoPreferredStorageOrderBit
const unsigned int NoPreferredStorageOrderBit
Definition: Constants.h:173
Eigen::EvalBeforeNestingBit
const unsigned int EvalBeforeNestingBit
Definition: Constants.h:65
Eigen::ComputationInfo
ComputationInfo
Definition: Constants.h:430
Eigen::WriteAccessors
@ WriteAccessors
Definition: Constants.h:368
Eigen::UnitLower
@ UnitLower
Definition: Constants.h:212
Eigen::Aligned32
@ Aligned32
Definition: Constants.h:231
Eigen::Infinity
const int Infinity
Definition: Constants.h:31
Eigen::Aligned64
@ Aligned64
Definition: Constants.h:232
Eigen::AccessorLevels
AccessorLevels
Definition: Constants.h:364
Eigen::SelfAdjoint
@ SelfAdjoint
Definition: Constants.h:220
Eigen::UnitDiag
@ UnitDiag
Definition: Constants.h:208
Eigen::Aligned
@ Aligned
Definition: Constants.h:235
Eigen::Dense
Definition: Constants.h:491