Eigen  3.3.90 (mercurial changeset b6e6d0cf6a77)

Detailed Description

Various enumerations used in Eigen. Many of these are used as template parameters.

Enumerations

enum  Eigen::AccessorLevels {
  Eigen::ReadOnlyAccessors,
  Eigen::WriteAccessors,
  Eigen::DirectAccessors,
  Eigen::DirectWriteAccessors
}
 
enum  Eigen::AlignmentType {
  Eigen::Unaligned,
  Eigen::Aligned8,
  Eigen::Aligned16,
  Eigen::Aligned32,
  Eigen::Aligned64,
  Eigen::Aligned128 ,
  Eigen::Aligned
}
 
enum  Eigen::ComputationInfo {
  Eigen::Success,
  Eigen::NumericalIssue,
  Eigen::NoConvergence,
  Eigen::InvalidInput
}
 
enum  Eigen::CornerType
 
enum  Eigen::DecompositionOptions { ,
  Eigen::ComputeFullU,
  Eigen::ComputeThinU,
  Eigen::ComputeFullV,
  Eigen::ComputeThinV,
  Eigen::EigenvaluesOnly,
  Eigen::ComputeEigenvectors ,
  Eigen::Ax_lBx,
  Eigen::ABx_lx,
  Eigen::BAx_lx
}
 
enum  Eigen::DirectionType {
  Eigen::Vertical,
  Eigen::Horizontal,
  Eigen::BothDirections
}
 
enum  Eigen::QRPreconditioners {
  Eigen::NoQRPreconditioner,
  Eigen::HouseholderQRPreconditioner,
  Eigen::ColPivHouseholderQRPreconditioner,
  Eigen::FullPivHouseholderQRPreconditioner
}
 
enum  Eigen::SideType {
  Eigen::OnTheLeft,
  Eigen::OnTheRight
}
 
enum  Eigen::StorageOptions {
  Eigen::ColMajor,
  Eigen::RowMajor,
  Eigen::AutoAlign,
  Eigen::DontAlign
}
 
enum  Eigen::TransformTraits {
  Eigen::Isometry,
  Eigen::Affine,
  Eigen::AffineCompact,
  Eigen::Projective
}
 
enum  Eigen::UpLoType {
  Eigen::Lower,
  Eigen::Upper,
  Eigen::UnitDiag,
  Eigen::ZeroDiag,
  Eigen::UnitLower,
  Eigen::UnitUpper,
  Eigen::StrictlyLower,
  Eigen::StrictlyUpper,
  Eigen::SelfAdjoint,
  Eigen::Symmetric
}
 

Enumeration Type Documentation

◆ AccessorLevels

Used as template parameter in DenseCoeffBase and MapBase to indicate which accessors should be provided.

Enumerator
ReadOnlyAccessors 

Read-only access via a member function.

WriteAccessors 

Read/write access via member functions.

DirectAccessors 

Direct read-only access to the coefficients.

DirectWriteAccessors 

Direct read/write access to the coefficients.

◆ AlignmentType

Enum for indicating whether a buffer is aligned or not.

Enumerator
Unaligned 

Data pointer has no specific alignment.

Aligned8 

Data pointer is aligned on a 8 bytes boundary.

Aligned16 

Data pointer is aligned on a 16 bytes boundary.

Aligned32 

Data pointer is aligned on a 32 bytes boundary.

Aligned64 

Data pointer is aligned on a 64 bytes boundary.

Aligned128 

Data pointer is aligned on a 128 bytes boundary.

Aligned 
Deprecated:
Synonym for Aligned16.

◆ ComputationInfo

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.

InvalidInput 

The inputs are invalid, or the algorithm has been improperly called. When assertions are enabled, such errors trigger an assert.

◆ CornerType

Enum used by DenseBase::corner() in Eigen2 compatibility mode.

◆ DecompositionOptions

Enum with options to give to various decompositions.

Enumerator
ComputeFullU 

Used in JacobiSVD to indicate that the square matrix U is to be computed.

ComputeThinU 

Used in JacobiSVD to indicate that the thin matrix U is to be computed.

ComputeFullV 

Used in JacobiSVD to indicate that the square matrix V is to be computed.

ComputeThinV 

Used in JacobiSVD to indicate that the thin matrix V is to be computed.

EigenvaluesOnly 

Used in SelfAdjointEigenSolver and GeneralizedSelfAdjointEigenSolver to specify that only the eigenvalues are to be computed and not the eigenvectors.

ComputeEigenvectors 

Used in SelfAdjointEigenSolver and GeneralizedSelfAdjointEigenSolver to specify that both the eigenvalues and the eigenvectors are to be computed.

Ax_lBx 

Used in GeneralizedSelfAdjointEigenSolver to indicate that it should solve the generalized eigenproblem $ Ax = \lambda B x $.

ABx_lx 

Used in GeneralizedSelfAdjointEigenSolver to indicate that it should solve the generalized eigenproblem $ ABx = \lambda x $.

BAx_lx 

Used in GeneralizedSelfAdjointEigenSolver to indicate that it should solve the generalized eigenproblem $ BAx = \lambda x $.

◆ DirectionType

Enum containing possible values for the Direction parameter of Reverse, PartialReduxExpr and VectorwiseOp.

Enumerator
Vertical 

For Reverse, all columns are reversed; for PartialReduxExpr and VectorwiseOp, act on columns.

Horizontal 

For Reverse, all rows are reversed; for PartialReduxExpr and VectorwiseOp, act on rows.

BothDirections 

For Reverse, both rows and columns are reversed; not used for PartialReduxExpr and VectorwiseOp.

◆ QRPreconditioners

Possible values for the QRPreconditioner template parameter of JacobiSVD.

Enumerator
NoQRPreconditioner 

Do not specify what is to be done if the SVD of a non-square matrix is asked for.

HouseholderQRPreconditioner 

Use a QR decomposition without pivoting as the first step.

ColPivHouseholderQRPreconditioner 

Use a QR decomposition with column pivoting as the first step.

FullPivHouseholderQRPreconditioner 

Use a QR decomposition with full pivoting as the first step.

◆ SideType

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.

◆ StorageOptions

Enum containing possible values for the _Options template parameter of Matrix, Array and BandMatrix.

Enumerator
ColMajor 

Storage order is column major (see Storage orders).

RowMajor 

Storage order is row major (see Storage orders).

AutoAlign 

Align the matrix itself if it is vectorizable fixed-size

DontAlign 

Don't require alignment for the matrix itself (the array of coefficients, if dynamically allocated, may still be requested to be aligned)

◆ TransformTraits

Enum used to specify how a particular transformation is stored in a matrix.

See also
Transform, Hyperplane::transform().
Enumerator
Isometry 

Transformation is an isometry.

Affine 

Transformation is an affine transformation stored as a (Dim+1)^2 matrix whose last row is assumed to be [0 ... 0 1].

AffineCompact 

Transformation is an affine transformation stored as a (Dim) x (Dim+1) matrix.

Projective 

Transformation is a general projective transformation stored as a (Dim+1)^2 matrix.

◆ UpLoType

Enum containing possible values for the Mode or UpLo parameter of MatrixBase::selfadjointView() and MatrixBase::triangularView(), and selfadjoint solvers.

Enumerator
Lower 

View matrix as a lower triangular matrix.

Upper 

View matrix as an upper triangular matrix.

UnitDiag 

Matrix has ones on the diagonal; to be used in combination with Lower or Upper.

ZeroDiag 

Matrix has zeros on the diagonal; to be used in combination with Lower or Upper.

UnitLower 

View matrix as a lower triangular matrix with ones on the diagonal.

UnitUpper 

View matrix as an upper triangular matrix with ones on the diagonal.

StrictlyLower 

View matrix as a lower triangular matrix with zeros on the diagonal.

StrictlyUpper 

View matrix as an upper triangular matrix with zeros on the diagonal.

SelfAdjoint 

Used in BandMatrix and SelfAdjointView to indicate that the matrix is self-adjoint.

Symmetric 

Used to support symmetric, non-selfadjoint, complex matrices.