Main MRPT website > C++ reference
MRPT logo
Classes | Namespaces | Enumerations | Variables

Constants.h File Reference

Go to the source code of this file.

Classes

struct  NoChange_t
struct  Sequential_t
struct  Default_t
struct  Dense
 The type used to identify a dense storage. More...
struct  MatrixXpr
 The type used to identify a matrix expression. More...
struct  ArrayXpr
 The type used to identify an array expression. More...

Namespaces

namespace  Architecture

Enumerations

enum  {
  Lower = 0x1, Upper = 0x2, UnitDiag = 0x4, ZeroDiag = 0x8,
  UnitLower = UnitDiag|Lower, UnitUpper = UnitDiag|Upper, StrictlyLower = ZeroDiag|Lower, StrictlyUpper = ZeroDiag|Upper,
  SelfAdjoint = 0x10
}
enum  { Unaligned = 0, Aligned = 1 }
enum  { ConditionalJumpCost = 5 }
enum  CornerType { TopLeft, TopRight, BottomLeft, BottomRight }
enum  DirectionType { Vertical, Horizontal, BothDirections }
enum  ProductEvaluationMode { NormalProduct, CacheFriendlyProduct }
enum  {
  DefaultTraversal, LinearTraversal, InnerVectorizedTraversal, LinearVectorizedTraversal,
  SliceVectorizedTraversal, InvalidTraversal
}
enum  { NoUnrolling, InnerUnrolling, CompleteUnrolling }
enum  { ColMajor = 0, RowMajor = 0x1, AutoAlign = 0, DontAlign = 0x2 }
enum  { OnTheLeft = 1, OnTheRight = 2 }
 

Enum for specifying whether to apply or solve on the left or right.

More...
enum  { IsDense = 0, IsSparse }
enum  AccessorLevels { ReadOnlyAccessors, WriteAccessors, DirectAccessors, DirectWriteAccessors }
enum  DecompositionOptions {
  Pivoting = 0x01, NoPivoting = 0x02, ComputeFullU = 0x04, ComputeThinU = 0x08,
  ComputeFullV = 0x10, ComputeThinV = 0x20, EigenvaluesOnly = 0x40, ComputeEigenvectors = 0x80,
  EigVecMask = EigenvaluesOnly | ComputeEigenvectors, Ax_lBx = 0x100, ABx_lx = 0x200, BAx_lx = 0x400,
  GenEigMask = Ax_lBx | ABx_lx | BAx_lx
}
enum  QRPreconditioners { NoQRPreconditioner, HouseholderQRPreconditioner, ColPivHouseholderQRPreconditioner, FullPivHouseholderQRPreconditioner }
enum  ComputationInfo { Success = 0, NumericalIssue = 1, NoConvergence = 2 }
 

Enum for reporting the status of a computation.

More...
enum  TransformTraits { Isometry = 0x1, Affine = 0x2, AffineCompact = 0x10 | Affine, Projective = 0x20 }
enum  Architecture::Type { Architecture::Generic = 0x0, Architecture::SSE = 0x1, Architecture::AltiVec = 0x2, Architecture::Target = Generic }
enum  {
  CoeffBasedProductMode, LazyCoeffBasedProductMode, OuterProduct, InnerProduct,
  GemvProduct, GemmProduct
}
enum  Action { GetAction, SetAction }

Variables

const int Dynamic = -1
 This value means that a quantity is not known at compile-time, and that instead the value is stored in some runtime variable.
const int Infinity = -1
 This value means +Infinity; it is currently used only as the p parameter to MatrixBase::lpNorm<int>().
const unsigned int RowMajorBit = 0x1
 for a matrix, this means that the storage order is row-major.
const unsigned int EvalBeforeNestingBit = 0x2
 means the expression should be evaluated by the calling expression
const unsigned int EvalBeforeAssigningBit = 0x4
 means the expression should be evaluated before any assignment
const unsigned int PacketAccessBit = 0x8
 Short version: means the expression might be vectorized.
const unsigned int ActualPacketAccessBit = 0x0
const unsigned int LinearAccessBit = 0x10
 Short version: means the expression can be seen as 1D vector.
const unsigned int LvalueBit = 0x20
 Means the expression has a coeffRef() method, i.e.
const unsigned int DirectAccessBit = 0x40
 Means that the underlying array of coefficients can be directly accessed as a plain strided array.
const unsigned int AlignedBit = 0x80
 means the first coefficient packet is guaranteed to be aligned
const unsigned int NestByRefBit = 0x100
const unsigned int HereditaryBits

Enumeration Type Documentation

anonymous enum
Enumerator:
Lower 
Upper 
UnitDiag 
ZeroDiag 
UnitLower 
UnitUpper 
StrictlyLower 
StrictlyUpper 
SelfAdjoint 

Definition at line 164 of file Constants.h.

anonymous enum
Enumerator:
Unaligned 
Aligned 

Definition at line 170 of file Constants.h.

anonymous enum
Enumerator:
ConditionalJumpCost 

Definition at line 171 of file Constants.h.

anonymous enum
Enumerator:
DefaultTraversal 
LinearTraversal 
InnerVectorizedTraversal 
LinearVectorizedTraversal 
SliceVectorizedTraversal 
InvalidTraversal 

Definition at line 180 of file Constants.h.

anonymous enum
Enumerator:
NoUnrolling 
InnerUnrolling 
CompleteUnrolling 

Definition at line 198 of file Constants.h.

anonymous enum
Enumerator:
ColMajor 
RowMajor 
AutoAlign 
DontAlign 

Definition at line 204 of file Constants.h.

anonymous enum

Enum for specifying whether to apply or solve on the left or right.

Enumerator:
OnTheLeft 

Apply transformation on the left.

OnTheRight 

Apply transformation on the right.

Definition at line 215 of file Constants.h.

anonymous enum
Enumerator:
IsDense 
IsSparse 

Definition at line 241 of file Constants.h.

anonymous enum
Enumerator:
CoeffBasedProductMode 
LazyCoeffBasedProductMode 
OuterProduct 
InnerProduct 
GemvProduct 
GemmProduct 

Definition at line 304 of file Constants.h.

Enumerator:
ReadOnlyAccessors 
WriteAccessors 
DirectAccessors 
DirectWriteAccessors 

Definition at line 246 of file Constants.h.

enum Action
Enumerator:
GetAction 
SetAction 

Definition at line 306 of file Constants.h.

Enum for reporting the status of a computation.

Enumerator:
Success 

Computation was successful.

NumericalIssue 

The provided data did not satisfy the prerequisites.

NoConvergence 

Iterative procedure did not converge.

Definition at line 275 of file Constants.h.

enum CornerType
Enumerator:
TopLeft 
TopRight 
BottomLeft 
BottomRight 

Definition at line 175 of file Constants.h.

Enumerator:
Pivoting 
NoPivoting 
ComputeFullU 
ComputeThinU 
ComputeFullV 
ComputeThinV 
EigenvaluesOnly 
ComputeEigenvectors 
EigVecMask 
Ax_lBx 
ABx_lx 
BAx_lx 
GenEigMask 

Definition at line 250 of file Constants.h.

Enumerator:
Vertical 
Horizontal 
BothDirections 

Definition at line 177 of file Constants.h.

Enumerator:
NormalProduct 
CacheFriendlyProduct 

Definition at line 178 of file Constants.h.

Enumerator:
NoQRPreconditioner 
HouseholderQRPreconditioner 
ColPivHouseholderQRPreconditioner 
FullPivHouseholderQRPreconditioner 

Definition at line 266 of file Constants.h.

Enumerator:
Isometry 
Affine 
AffineCompact 
Projective 

Definition at line 281 of file Constants.h.


Variable Documentation

const unsigned int ActualPacketAccessBit = 0x0
const int Dynamic = -1

This value means that a quantity is not known at compile-time, and that instead the value is stored in some runtime variable.

Changing the value of Dynamic breaks the ABI, as Dynamic is often used as a template parameter for Matrix.

Definition at line 34 of file Constants.h.

Referenced by PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::_init2(), PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::_swap(), AlignedBox< _Scalar, _AmbientDim >::AlignedBox(), DenseBase< Derived >::all(), JacobiSVD< _MatrixType, QRPreconditioner >::allocate(), DenseBase< Derived >::any(), internal::apply_rotation_in_the_plane(), Array< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >::Array(), Block< XprType, BlockRows, BlockCols, InnerPanel, true >::Block(), Block< VectorType, internal::traits< VectorType >::Flags &RowMajorBit?1:Size, internal::traits< VectorType >::Flags &RowMajorBit?Size:1 >::Block(), CwiseBinaryOp< BinaryOp, Lhs, Rhs >::cols(), CwiseNullaryOp< NullaryOp, PlainObjectType >::CwiseNullaryOp(), Hyperplane< _Scalar, _AmbientDim >::dim(), AlignedBox< _Scalar, _AmbientDim >::dim(), internal::homogeneous_right_product_impl< Homogeneous< MatrixType, Horizontal >, Rhs >::evalTo(), internal::homogeneous_left_product_impl< Homogeneous< MatrixType, Vertical >, Lhs >::evalTo(), internal::kernel_retval< FullPivLU< _MatrixType > >::evalTo(), TriangularBase< Derived >::evalToLazy(), MatrixBase< Derived >::fromMatlabStringFormat(), TriangularView< _MatrixType, _Mode >::lazyAssign(), MatrixBase< Derived >::lazyProduct(), MatrixBase< Derived >::loadFromTextFile(), MapBase< Derived, ReadOnlyAccessors >::MapBase(), Matrix< Scalar, Rows, HDim >::Matrix(), MatrixBase< Derived >::operator*(), CommaInitializer< XprType >::operator,(), CoeffBasedProduct< LhsNested, RhsNested, NestingFlags >::packet(), DenseBase< Derived >::prod(), Replicate< MatrixType, RowFactor, ColFactor >::Replicate(), PlainObjectBase< Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols > >::resize(), CwiseBinaryOp< BinaryOp, Lhs, Rhs >::rows(), internal::determinant_impl< Derived, DeterminantType >::run(), GeneralProduct< Lhs, Rhs, GemmProduct >::scaleAndAddTo(), setSize(), SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >::SparseInnerVectorSet(), SparseInnerVectorSet< MatrixType, Size >::SparseInnerVectorSet(), SparseSparseProduct< LhsNested, RhsNested >::SparseSparseProduct(), Stride< 0, Value >::Stride(), DenseBase< Derived >::sum(), and DenseBase< Derived >::visit().

const unsigned int HereditaryBits
Initial value:

Definition at line 159 of file Constants.h.

const int Infinity = -1

This value means +Infinity; it is currently used only as the p parameter to MatrixBase::lpNorm<int>().

The value Infinity there means the L-infinity norm.

Definition at line 39 of file Constants.h.

const unsigned int NestByRefBit = 0x100

Definition at line 156 of file Constants.h.




Page generated by Doxygen 1.7.2 for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011