Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
Eigen Namespace Reference

Namespaces

 Architecture
 
 half_impl
 
 internal
 
 numext
 

Classes

class  aligned_allocator
 STL compatible allocator to use with with 16 byte aligned types. More...
 
class  aligned_allocator_indirection
 
class  AlignedBox
 An axis aligned box. More...
 
class  AMDOrdering
 
class  AngleAxis
 Represents a 3D rotation as a rotation angle around an arbitrary 3D axis. More...
 
class  Array
 General-purpose arrays with easy API for coefficient-wise operations. More...
 
class  ArrayBase
 Base class for all 1D and 2D array, and related expressions. More...
 
class  ArrayWrapper
 Expression of a mathematical vector or matrix as an array object. More...
 
struct  ArrayXpr
 
struct  BandShape
 
class  BDCSVD
 class Bidiagonal Divide and Conquer SVD More...
 
class  BiCGSTAB
 A bi conjugate gradient stabilized solver for sparse square problems. More...
 
class  Block
 Expression of a fixed-size or dynamic-size block. More...
 
class  BlockImpl
 
class  BlockImpl< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true, Sparse >
 
class  BlockImpl< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true, Sparse >
 
class  BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Dense >
 
class  BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >
 
class  BlockImpl< XprType, BlockRows, BlockCols, true, Sparse >
 
class  CholmodBase
 The base class for the direct Cholesky factorization of Cholmod. More...
 
class  CholmodDecomposition
 A general Cholesky factorization and solver based on Cholmod. More...
 
class  CholmodSimplicialLDLT
 A simplicial direct Cholesky (LDLT) factorization and solver based on Cholmod. More...
 
class  CholmodSimplicialLLT
 A simplicial direct Cholesky (LLT) factorization and solver based on Cholmod. More...
 
class  CholmodSupernodalLLT
 A supernodal Cholesky (LLT) factorization and solver based on Cholmod. More...
 
class  COLAMDOrdering
 
class  ColPivHouseholderQR
 Householder rank-revealing QR decomposition of a matrix with column-pivoting. More...
 
class  CommaInitializer
 Helper class used by the comma initializer operator. More...
 
class  CompleteOrthogonalDecomposition
 Complete orthogonal decomposition (COD) of a matrix. More...
 
class  ComplexEigenSolver
 Computes eigenvalues and eigenvectors of general complex matrices. More...
 
class  ComplexSchur
 Performs a complex Schur decomposition of a real or complex square matrix. More...
 
class  Conjugate
 
class  ConjugateGradient
 A conjugate gradient solver for sparse (or dense) self-adjoint problems. More...
 
class  Cross
 
class  CwiseBinaryOp
 Generic expression where a coefficient-wise binary operator is applied to two expressions. More...
 
class  CwiseBinaryOpImpl
 
class  CwiseBinaryOpImpl< BinaryOp, Lhs, Rhs, Sparse >
 
class  CwiseNullaryOp
 Generic expression of a matrix where all coefficients are defined by a functor. More...
 
class  CwiseTernaryOp
 Generic expression where a coefficient-wise ternary operator is applied to two expressions. More...
 
class  CwiseTernaryOpImpl
 
class  CwiseUnaryOp
 Generic expression where a coefficient-wise unary operator is applied to an expression. More...
 
class  CwiseUnaryOpImpl
 
class  CwiseUnaryView
 Generic lvalue expression of a coefficient-wise unary operator of a matrix or a vector. More...
 
class  CwiseUnaryViewImpl
 
class  CwiseUnaryViewImpl< ViewOp, MatrixType, Dense >
 
struct  Dense
 
class  DenseBase
 Base class for all dense matrices, vectors, and arrays. More...
 
class  DenseCoeffsBase
 
class  DenseCoeffsBase< Derived, DirectAccessors >
 Base class providing direct read-only coefficient access to matrices and arrays. More...
 
class  DenseCoeffsBase< Derived, DirectWriteAccessors >
 Base class providing direct read/write coefficient access to matrices and arrays. More...
 
class  DenseCoeffsBase< Derived, ReadOnlyAccessors >
 Base class providing read-only coefficient access to matrices and arrays. More...
 
class  DenseCoeffsBase< Derived, WriteAccessors >
 Base class providing read/write coefficient access to matrices and arrays. More...
 
struct  DenseShape
 
struct  DenseSparseProductReturnType
 
class  DenseStorage
 
class  DenseStorage< T, 0, _Rows, _Cols, _Options >
 
class  DenseStorage< T, 0, _Rows, Dynamic, _Options >
 
class  DenseStorage< T, 0, Dynamic, _Cols, _Options >
 
class  DenseStorage< T, 0, Dynamic, Dynamic, _Options >
 
class  DenseStorage< T, Dynamic, _Rows, Dynamic, _Options >
 
class  DenseStorage< T, Dynamic, Dynamic, _Cols, _Options >
 
class  DenseStorage< T, Dynamic, Dynamic, Dynamic, _Options >
 
class  DenseStorage< T, Size, _Rows, Dynamic, _Options >
 
class  DenseStorage< T, Size, Dynamic, _Cols, _Options >
 
class  DenseStorage< T, Size, Dynamic, Dynamic, _Options >
 
class  DenseTimeSparseProduct
 
class  Diagonal
 Expression of a diagonal/subdiagonal/superdiagonal in a matrix. More...
 
class  DiagonalBase
 
class  DiagonalMatrix
 Represents a diagonal matrix with its storage. More...
 
class  DiagonalPreconditioner
 A preconditioner based on the digonal entries. More...
 
class  DiagonalProduct
 
struct  DiagonalShape
 
class  DiagonalWrapper
 Expression of a diagonal matrix. More...
 
class  DynamicSparseMatrix
 
class  EigenBase
 
class  EigenSolver
 Computes eigenvalues and eigenvectors of general matrices. More...
 
class  Flagged
 
class  ForceAlignedAccess
 Enforce aligned packet loads and stores regardless of what is requested. More...
 
class  FullPivHouseholderQR
 Householder rank-revealing QR decomposition of a matrix with full pivoting. More...
 
class  FullPivLU
 LU decomposition of a matrix with complete pivoting, and related features. More...
 
struct  general_product_to_triangular_selector
 
struct  general_product_to_triangular_selector< MatrixType, ProductType, UpLo, false >
 
struct  general_product_to_triangular_selector< MatrixType, ProductType, UpLo, true >
 
class  GeneralizedEigenSolver
 Computes the generalized eigenvalues and eigenvectors of a pair of general matrices. More...
 
class  GeneralizedSelfAdjointEigenSolver
 Computes eigenvalues and eigenvectors of the generalized selfadjoint eigen problem. More...
 
struct  GenericNumTraits
 
struct  half
 
class  HessenbergDecomposition
 Reduces a square matrix to Hessenberg form by an orthogonal similarity transformation. More...
 
class  Homogeneous
 Expression of one (or a set of) homogeneous vector(s) More...
 
struct  HomogeneousShape
 
class  HouseholderQR
 Householder QR decomposition of a matrix. More...
 
class  HouseholderSequence
 Sequence of Householder reflections acting on subspaces with decreasing size. More...
 
class  Hyperplane
 A hyperplane. More...
 
class  IdentityPreconditioner
 A naive preconditioner which approximates any matrix as the identity matrix. More...
 
class  IncompleteCholesky
 Modified Incomplete Cholesky with dual threshold. More...
 
class  IncompleteLUT
 Incomplete LU factorization with dual-threshold strategy. More...
 
class  InnerIterator
 An InnerIterator allows to loop over the element of any matrix expression. More...
 
class  InnerStride
 Convenience specialization of Stride to specify only an inner stride See class Map for some examples. More...
 
class  Inverse
 Expression of the inverse of another expression. More...
 
class  InverseImpl
 
class  InverseImpl< PermutationType, PermutationStorage >
 
class  IOFormat
 Stores a set of parameters controlling the way matrices are printed. More...
 
class  IterativeSolverBase
 Base class for linear iterative solvers. More...
 
class  JacobiRotation
 Rotation given by a cosine-sine pair. More...
 
class  JacobiSVD
 Two-sided Jacobi SVD decomposition of a rectangular matrix. More...
 
struct  LazyProductReturnType
 
class  LDLT
 Robust Cholesky decomposition of a matrix with pivoting. More...
 
class  LeastSquareDiagonalPreconditioner
 Jacobi preconditioner for LeastSquaresConjugateGradient. More...
 
class  LeastSquaresConjugateGradient
 A conjugate gradient solver for sparse (or dense) least-square problems. More...
 
class  LLT
 Standard Cholesky decomposition (LL^T) of a matrix and associated features. More...
 
class  Map
 A matrix or vector expression mapping an existing array of data. More...
 
class  Map< const Quaternion< _Scalar >, _Options >
 Quaternion expression mapping a constant memory buffer. More...
 
class  Map< const SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >
 
class  Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >, _PacketAccess >
 
class  Map< Quaternion< _Scalar >, _Options >
 Expression of a quaternion from a memory buffer. More...
 
class  Map< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >
 Specialization of class Map for SparseMatrix-like storage. More...
 
class  Map< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >, PacketAccess >
 
class  MapBase
 
class  MapBase< Derived, ReadOnlyAccessors >
 Base class for dense Map and Block expression with direct access. More...
 
class  MapBase< Derived, WriteAccessors >
 Base class for non-const dense Map and Block expression with direct access. More...
 
class  MappedSparseMatrix
 Sparse matrix. More...
 
class  Matrix
 The matrix class, also used for vectors and row-vectors. More...
 
class  MatrixBase
 Base class for all dense matrices, vectors, and expressions. More...
 
class  MatrixComplexPowerReturnValue
 
struct  MatrixExponentialReturnValue
 
class  MatrixFunctionReturnValue
 
class  MatrixLogarithmReturnValue
 
class  MatrixPowerReturnValue
 
class  MatrixSquareRootReturnValue
 
class  MatrixWrapper
 Expression of an array as a mathematical vector or matrix. More...
 
struct  MatrixXpr
 
class  MetisOrdering
 
class  NaturalOrdering
 
class  NestByValue
 Expression which must be nested by value. More...
 
class  NoAlias
 Pseudo expression providing an operator = assuming no aliasing. More...
 
class  NumTraits
 Holds information about the various numeric (i.e. scalar) types allowed by Eigen. More...
 
struct  NumTraits< Array< Scalar, Rows, Cols, Options, MaxRows, MaxCols > >
 
struct  NumTraits< double >
 
struct  NumTraits< Eigen::half >
 
struct  NumTraits< float >
 
struct  NumTraits< long double >
 
struct  NumTraits< std::complex< _Real > >
 
struct  NumTraits< std::string >
 
struct  NumTraits< void >
 
class  OuterStride
 Convenience specialization of Stride to specify only an outer stride See class Map for some examples. More...
 
class  ParametrizedLine
 A parametrized line. More...
 
class  PardisoImpl
 
class  PardisoLDLT
 A sparse direct Cholesky (LDLT) factorization and solver based on the PARDISO library. More...
 
class  PardisoLLT
 A sparse direct Cholesky (LLT) factorization and solver based on the PARDISO library. More...
 
class  PardisoLU
 A sparse direct LU factorization and solver based on the PARDISO library. More...
 
class  PartialPivLU
 LU decomposition of a matrix with partial pivoting, and related features. More...
 
class  PartialReduxExpr
 Generic expression of a partially reduxed matrix. More...
 
class  PastixBase
 
class  PastixLDLT
 A sparse direct supernodal Cholesky (LLT) factorization and solver based on the PaStiX library. More...
 
class  PastixLLT
 A sparse direct supernodal Cholesky (LLT) factorization and solver based on the PaStiX library. More...
 
class  PastixLU
 Interface to the PaStix solver. More...
 
class  PermutationBase
 Base class for permutations. More...
 
class  PermutationMatrix
 Permutation matrix. More...
 
struct  PermutationShape
 
struct  PermutationStorage
 
class  PermutationWrapper
 Class to view a vector of integers as a permutation matrix. More...
 
class  PlainObjectBase
 Dense storage base class for matrices and arrays. More...
 
class  Product
 Expression of the product of two arbitrary matrices or vectors. More...
 
class  ProductImpl
 
class  ProductImpl< Lhs, Rhs, Option, Dense >
 
struct  ProductReturnType
 
class  Quaternion
 The quaternion class used to represent 3D orientations and rotations. More...
 
class  QuaternionBase
 Base class for quaternion expressions. More...
 
class  RealQZ
 Performs a real QZ decomposition of a pair of square matrices. More...
 
class  RealSchur
 Performs a real Schur decomposition of a square matrix. More...
 
class  Ref
 A matrix or vector expression mapping an existing expression. More...
 
class  Ref< const SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >
 
class  Ref< const SparseVector< MatScalar, MatOptions, MatIndex >, Options, StrideType >
 
class  Ref< const TPlainObjectType, Options, StrideType >
 
class  Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >
 A sparse matrix expression referencing an existing sparse expression. More...
 
class  Ref< SparseVector< MatScalar, MatOptions, MatIndex >, Options, StrideType >
 A sparse vector expression referencing an existing sparse vector expression. More...
 
class  RefBase
 
class  Replicate
 Expression of the multiple replication of a matrix or vector. More...
 
class  ReturnByValue
 
class  Reverse
 Expression of the reverse of a vector or matrix. More...
 
class  Rotation2D
 Represents a rotation/orientation in a 2 dimensional space. More...
 
class  RotationBase
 Common base class for compact rotation representations. More...
 
class  ScalarBinaryOpTraits
 Determines whether the given binary operation of two numeric types is allowed and what the scalar return type is. More...
 
struct  ScalarBinaryOpTraits< T, T, BinaryOp >
 
struct  ScalarBinaryOpTraits< T, typename NumTraits< typename internal::enable_if< NumTraits< T >::IsComplex, T >::type >::Real, BinaryOp >
 
struct  ScalarBinaryOpTraits< T, void, BinaryOp >
 
struct  ScalarBinaryOpTraits< typename NumTraits< typename internal::enable_if< NumTraits< T >::IsComplex, T >::type >::Real, T, BinaryOp >
 
struct  ScalarBinaryOpTraits< void, T, BinaryOp >
 
struct  ScalarBinaryOpTraits< void, void, BinaryOp >
 
class  Select
 Expression of a coefficient wise version of the C++ ternary operator ?: More...
 
struct  selfadjoint_product_selector
 
struct  selfadjoint_product_selector< MatrixType, OtherType, UpLo, false >
 
struct  selfadjoint_product_selector< MatrixType, OtherType, UpLo, true >
 
struct  selfadjoint_rank1_update
 
struct  selfadjoint_rank1_update< Scalar, Index, ColMajor, UpLo, ConjLhs, ConjRhs >
 
struct  selfadjoint_rank1_update< Scalar, Index, RowMajor, UpLo, ConjLhs, ConjRhs >
 
class  SelfAdjointEigenSolver
 Computes eigenvalues and eigenvectors of selfadjoint matrices. More...
 
struct  SelfAdjointShape
 
class  SelfAdjointView
 Expression of a selfadjoint matrix from a triangular part of a dense matrix. More...
 
class  SimplicialCholesky
 
class  SimplicialCholeskyBase
 A base class for direct sparse Cholesky factorizations. More...
 
class  SimplicialLDLT
 A direct sparse LDLT Cholesky factorizations without square root. More...
 
class  SimplicialLLT
 A direct sparse LLT Cholesky factorizations. More...
 
struct  SluMatrix
 
struct  SluMatrixMapHelper
 
struct  SluMatrixMapHelper< Matrix< Scalar, Rows, Cols, Options, MRows, MCols > >
 
struct  SluMatrixMapHelper< SparseMatrixBase< Derived > >
 
class  Solve
 Pseudo expression representing a solving operation. More...
 
class  SolveImpl
 
class  SolveImpl< Decomposition, RhsType, Dense >
 
class  SolverBase
 A base class for matrix decomposition and solvers. More...
 
struct  SolverShape
 
struct  SolverStorage
 
class  SolveWithGuess
 Pseudo expression representing a solving operation. More...
 
struct  Sparse
 
class  SparseCompressedBase
 Common base class for sparse [compressed]-{row|column}-storage format. More...
 
class  SparseDenseOuterProduct
 
struct  SparseDenseProductReturnType
 
class  SparseDiagonalProduct
 
class  SparseLU
 Sparse supernodal LU factorization for general matrices. More...
 
struct  SparseLUMatrixLReturnType
 
struct  SparseLUMatrixUReturnType
 
class  SparseMapBase
 
class  SparseMapBase< Derived, ReadOnlyAccessors >
 Common base class for Map and Ref instance of sparse matrix and vector. More...
 
class  SparseMapBase< Derived, WriteAccessors >
 Common base class for writable Map and Ref instance of sparse matrix and vector. More...
 
class  SparseMatrix
 A versatible sparse matrix representation. More...
 
class  SparseMatrixBase
 Base class of any sparse matrices or sparse expressions. More...
 
class  SparseQR
 Sparse left-looking rank-revealing QR factorization. More...
 
struct  SparseQR_QProduct
 
struct  SparseQRMatrixQReturnType
 
struct  SparseQRMatrixQTransposeReturnType
 
class  SparseSelfAdjointView
 Pseudo expression to manipulate a triangular sparse matrix as a selfadjoint matrix. More...
 
struct  SparseShape
 
class  SparseSolverBase
 A base class for sparse solvers. More...
 
class  SparseSparseProduct
 
struct  SparseSparseProductReturnType
 
class  SparseSymmetricPermutationProduct
 
class  SparseTimeDenseProduct
 
class  SparseVector
 a sparse vector class More...
 
class  SparseView
 
class  SPQR
 Sparse QR factorization based on SuiteSparseQR library. More...
 
struct  SPQR_QProduct
 
struct  SPQRMatrixQReturnType
 
struct  SPQRMatrixQTransposeReturnType
 
class  Stride
 Holds strides information for Map. More...
 
class  SuperLU
 A sparse direct LU factorization and solver based on the SuperLU library. More...
 
class  SuperLUBase
 The base class for the direct and incomplete LU factorization of SuperLU. More...
 
class  SVDBase
 Base class of SVD algorithms. More...
 
class  SwapWrapper
 
class  Transform
 Represents an homogeneous transformation in a N dimensional space. More...
 
class  Translation
 Represents a translation transformation. More...
 
class  Transpose
 Expression of the transpose of a matrix. More...
 
class  Transpose< TranspositionsBase< TranspositionsDerived > >
 
class  TransposeImpl
 
class  TransposeImpl< MatrixType, Dense >
 
class  TransposeImpl< MatrixType, Sparse >
 
class  Transpositions
 Represents a sequence of transpositions (row/column interchange) More...
 
class  TranspositionsBase
 
struct  TranspositionsShape
 
struct  TranspositionsStorage
 
class  TranspositionsWrapper
 
class  TriangularBase
 Base class for triangular part in a matrix. More...
 
struct  TriangularShape
 
class  TriangularView
 Expression of a triangular part in a matrix. More...
 
class  TriangularViewImpl
 
class  TriangularViewImpl< _MatrixType, _Mode, Dense >
 Base class for a triangular part in a dense matrix. More...
 
class  TriangularViewImpl< MatrixType, Mode, Sparse >
 Base class for a triangular part in a sparse matrix. More...
 
class  Tridiagonalization
 Tridiagonal decomposition of a selfadjoint matrix. More...
 
class  Triplet
 A small structure to hold a non zero as a triplet (i,j,value). More...
 
class  UmfPackLU
 A sparse LU factorization and solver based on UmfPack. More...
 
class  UniformScaling
 
class  VectorBlock
 Expression of a fixed-size or dynamic-size sub-vector. More...
 
class  VectorwiseOp
 Pseudo expression providing partial reduction operations. More...
 
class  WithFormat
 Pseudo expression providing matrix output with given format. More...
 

Typedefs

typedef Transform< double, 2, AffineAffine2d
 
typedef Transform< float, 2, AffineAffine2f
 
typedef Transform< double, 3, AffineAffine3d
 
typedef Transform< float, 3, AffineAffine3f
 
typedef Transform< double, 2, AffineCompactAffineCompact2d
 
typedef Transform< float, 2, AffineCompactAffineCompact2f
 
typedef Transform< double, 3, AffineCompactAffineCompact3d
 
typedef Transform< float, 3, AffineCompactAffineCompact3f
 
typedef DiagonalMatrix< double, 2 > AlignedScaling2d
 
typedef DiagonalMatrix< float, 2 > AlignedScaling2f
 
typedef DiagonalMatrix< double, 3 > AlignedScaling3d
 
typedef DiagonalMatrix< float, 3 > AlignedScaling3f
 
typedef AngleAxis< double > AngleAxisd
 
typedef AngleAxis< float > AngleAxisf
 
typedef int BlasIndex
 
typedef std::complex< double > dcomplex
 
typedef EIGEN_DEFAULT_DENSE_INDEX_TYPE DenseIndex
 
typedef EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
 The Index type as used for the API. More...
 
typedef Transform< double, 2, IsometryIsometry2d
 
typedef Transform< float, 2, IsometryIsometry2f
 
typedef Transform< double, 3, IsometryIsometry3d
 
typedef Transform< float, 3, IsometryIsometry3f
 
typedef Transform< double, 2, ProjectiveProjective2d
 
typedef Transform< float, 2, ProjectiveProjective2f
 
typedef Transform< double, 3, ProjectiveProjective3d
 
typedef Transform< float, 3, ProjectiveProjective3f
 
typedef Quaternion< double > Quaterniond
 
typedef Quaternion< float > Quaternionf
 
typedef Map< Quaternion< double >, AlignedQuaternionMapAlignedd
 
typedef Map< Quaternion< float >, AlignedQuaternionMapAlignedf
 
typedef Map< Quaternion< double >, 0 > QuaternionMapd
 
typedef Map< Quaternion< float >, 0 > QuaternionMapf
 
typedef Rotation2D< double > Rotation2Dd
 
typedef Rotation2D< float > Rotation2Df
 
typedef std::complex< float > scomplex
 
typedef Translation< double, 2 > Translation2d
 
typedef Translation< float, 2 > Translation2f
 
typedef Translation< double, 3 > Translation3d
 
typedef Translation< float, 3 > Translation3f
 

Enumerations

enum  { Large = 2, Small = 3 }
 
enum  { DontAlignCols = 1 }
 
enum  { StreamPrecision = -1, FullPrecision = -2 }
 
enum  { StandardCompressedFormat = 2 }
 
enum  AccessorLevels { ReadOnlyAccessors, WriteAccessors, DirectAccessors, DirectWriteAccessors }
 
enum  Action { GetAction, SetAction }
 
enum  AlignmentType {
  Unaligned =0, Aligned8 =8, Aligned16 =16, Aligned32 =32,
  Aligned64 =64, Aligned128 =128, AlignedMask =255, Aligned =16,
  AlignedMax = Unaligned
}
 
enum  AmbiVectorMode { IsDense = 0, IsSparse }
 
enum  CholmodMode { CholmodAuto, CholmodSimplicialLLt, CholmodSupernodalLLt, CholmodLDLt }
 
enum  ComputationInfo { Success = 0, NumericalIssue = 1, NoConvergence = 2, InvalidInput = 3 }
 
enum  CornerType { TopLeft, TopRight, BottomLeft, BottomRight }
 
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  Default_t { Default }
 
enum  DirectionType { Vertical, Horizontal, BothDirections }
 
enum  NoChange_t { NoChange }
 
enum  ProductImplType {
  DefaultProduct =0, LazyProduct, AliasFreeProduct, CoeffBasedProductMode,
  LazyCoeffBasedProductMode, OuterProduct, InnerProduct, GemvProduct,
  GemmProduct
}
 
enum  QRPreconditioners { NoQRPreconditioner, HouseholderQRPreconditioner, ColPivHouseholderQRPreconditioner, FullPivHouseholderQRPreconditioner }
 
enum  Sequential_t { Sequential }
 
enum  SideType { OnTheLeft = 1, OnTheRight = 2 }
 
enum  SimplicialCholeskyMode { SimplicialCholeskyLLT, SimplicialCholeskyLDLT }
 
enum  SpecializedType { Specialized, BuiltIn }
 
enum  StorageOptions { ColMajor = 0, RowMajor = 0x1, AutoAlign = 0, DontAlign = 0x2 }
 
enum  TransformTraits { Isometry = 0x1, Affine = 0x2, AffineCompact = 0x10 | Affine, Projective = 0x20 }
 
enum  TraversalType {
  DefaultTraversal, LinearTraversal, InnerVectorizedTraversal, LinearVectorizedTraversal,
  SliceVectorizedTraversal, InvalidTraversal, AllAtOnceTraversal
}
 
enum  UnrollingType { NoUnrolling, InnerUnrolling, CompleteUnrolling }
 
enum  UpLoType {
  Lower =0x1, Upper =0x2, UnitDiag =0x4, ZeroDiag =0x8,
  UnitLower =UnitDiag|Lower, UnitUpper =UnitDiag|Upper, StrictlyLower =ZeroDiag|Lower, StrictlyUpper =ZeroDiag|Upper,
  SelfAdjoint =0x10, Symmetric =0x20
}
 

Functions

template<typename Derived >
const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE (Derived, typename Derived::Scalar, pow) pow(const Eigen
 
template<typename Derived >
const EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE (typename Derived::Scalar, Derived, pow) pow(const typename Derived
 
template<typename VectorsType , typename CoeffsType >
HouseholderSequence< VectorsType, CoeffsType > householderSequence (const VectorsType &v, const CoeffsType &h)
 Convenience function for constructing a Householder sequence. More...
 
void initParallel ()
 
std::ptrdiff_t l1CacheSize ()
 
std::ptrdiff_t l2CacheSize ()
 
std::ptrdiff_t l3CacheSize ()
 
int nbThreads ()
 
template<typename SparseDerived , typename PermDerived >
const Product< SparseDerived, PermDerived, AliasFreeProductoperator* (const SparseMatrixBase< SparseDerived > &matrix, const PermutationBase< PermDerived > &perm)
 
template<typename SparseDerived , typename PermDerived >
const Product< PermDerived, SparseDerived, AliasFreeProductoperator* (const PermutationBase< PermDerived > &perm, const SparseMatrixBase< SparseDerived > &matrix)
 
template<typename SparseDerived , typename PermutationType >
const Product< SparseDerived, Inverse< PermutationType >, AliasFreeProductoperator* (const SparseMatrixBase< SparseDerived > &matrix, const InverseImpl< PermutationType, PermutationStorage > &tperm)
 
template<typename SparseDerived , typename PermutationType >
const Product< Inverse< PermutationType >, SparseDerived, AliasFreeProductoperator* (const InverseImpl< PermutationType, PermutationStorage > &tperm, const SparseMatrixBase< SparseDerived > &matrix)
 
template<typename MatrixDerived , typename TranspositionsDerived >
EIGEN_DEVICE_FUNC const Product< MatrixDerived, TranspositionsDerived, AliasFreeProductoperator* (const MatrixBase< MatrixDerived > &matrix, const TranspositionsBase< TranspositionsDerived > &transpositions)
 
template<typename TranspositionsDerived , typename MatrixDerived >
EIGEN_DEVICE_FUNC const Product< TranspositionsDerived, MatrixDerived, AliasFreeProductoperator* (const TranspositionsBase< TranspositionsDerived > &transpositions, const MatrixBase< MatrixDerived > &matrix)
 
template<typename OtherDerived , typename VectorsType , typename CoeffsType , int Side>
internal::matrix_type_times_scalar_type< typename VectorsType::Scalar, OtherDerived >::Type operator* (const MatrixBase< OtherDerived > &other, const HouseholderSequence< VectorsType, CoeffsType, Side > &h)
 Computes the product of a matrix with a Householder sequence. More...
 
template<typename MatrixDerived , typename PermutationDerived >
EIGEN_DEVICE_FUNC const Product< MatrixDerived, PermutationDerived, AliasFreeProductoperator* (const MatrixBase< MatrixDerived > &matrix, const PermutationBase< PermutationDerived > &permutation)
 
template<typename PermutationDerived , typename MatrixDerived >
EIGEN_DEVICE_FUNC const Product< PermutationDerived, MatrixDerived, AliasFreeProductoperator* (const PermutationBase< PermutationDerived > &permutation, const MatrixBase< MatrixDerived > &matrix)
 
template<typename DenseDerived , typename SparseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_sum_op< typename DenseDerived::Scalar, typename SparseDerived::Scalar >, const DenseDerived, const SparseDerived > operator+ (const MatrixBase< DenseDerived > &a, const SparseMatrixBase< SparseDerived > &b)
 
template<typename SparseDerived , typename DenseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_sum_op< typename SparseDerived::Scalar, typename DenseDerived::Scalar >, const SparseDerived, const DenseDerived > operator+ (const SparseMatrixBase< SparseDerived > &a, const MatrixBase< DenseDerived > &b)
 
template<typename DenseDerived , typename SparseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_difference_op< typename DenseDerived::Scalar, typename SparseDerived::Scalar >, const DenseDerived, const SparseDerived > operator- (const MatrixBase< DenseDerived > &a, const SparseMatrixBase< SparseDerived > &b)
 
template<typename SparseDerived , typename DenseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_difference_op< typename SparseDerived::Scalar, typename DenseDerived::Scalar >, const SparseDerived, const DenseDerived > operator- (const SparseMatrixBase< SparseDerived > &a, const MatrixBase< DenseDerived > &b)
 
template<typename VectorsType , typename CoeffsType >
HouseholderSequence< VectorsType, CoeffsType, OnTheRightrightHouseholderSequence (const VectorsType &v, const CoeffsType &h)
 Convenience function for constructing a Householder sequence. More...
 
UniformScaling< float > Scaling (float s)
 
UniformScaling< double > Scaling (double s)
 
template<typename RealScalar >
UniformScaling< std::complex< RealScalar > > Scaling (const std::complex< RealScalar > &s)
 
template<typename Scalar >
DiagonalMatrix< Scalar, 2 > Scaling (const Scalar &sx, const Scalar &sy)
 
template<typename Scalar >
DiagonalMatrix< Scalar, 3 > Scaling (const Scalar &sx, const Scalar &sy, const Scalar &sz)
 
template<typename Derived >
const DiagonalWrapper< const Derived > Scaling (const MatrixBase< Derived > &coeffs)
 
void setCpuCacheSizes (std::ptrdiff_t l1, std::ptrdiff_t l2, std::ptrdiff_t l3)
 
void setNbThreads (int v)
 
template<typename Derived , typename OtherDerived >
internal::umeyama_transform_matrix_type< Derived, OtherDerived >::type umeyama (const MatrixBase< Derived > &src, const MatrixBase< OtherDerived > &dst, bool with_scaling=true)
 Returns the transformation between two point sets. More...
 
void umfpack_defaults (double control[UMFPACK_CONTROL], double)
 
void umfpack_defaults (double control[UMFPACK_CONTROL], std::complex< double >)
 
void umfpack_free_numeric (void **Numeric, double)
 
void umfpack_free_numeric (void **Numeric, std::complex< double >)
 
void umfpack_free_symbolic (void **Symbolic, double)
 
void umfpack_free_symbolic (void **Symbolic, std::complex< double >)
 
int umfpack_get_determinant (double *Mx, double *Ex, void *NumericHandle, double User_Info [UMFPACK_INFO])
 
int umfpack_get_determinant (std::complex< double > *Mx, double *Ex, void *NumericHandle, double User_Info [UMFPACK_INFO])
 
int umfpack_get_lunz (int *lnz, int *unz, int *n_row, int *n_col, int *nz_udiag, void *Numeric, double)
 
int umfpack_get_lunz (int *lnz, int *unz, int *n_row, int *n_col, int *nz_udiag, void *Numeric, std::complex< double >)
 
int umfpack_get_numeric (int Lp[], int Lj[], double Lx[], int Up[], int Ui[], double Ux[], int P[], int Q[], double Dx[], int *do_recip, double Rs[], void *Numeric)
 
int umfpack_get_numeric (int Lp[], int Lj[], std::complex< double > Lx[], int Up[], int Ui[], std::complex< double > Ux[], int P[], int Q[], std::complex< double > Dx[], int *do_recip, double Rs[], void *Numeric)
 
int umfpack_numeric (const int Ap[], const int Ai[], const double Ax[], void *Symbolic, void **Numeric, const double Control[UMFPACK_CONTROL], double Info [UMFPACK_INFO])
 
int umfpack_numeric (const int Ap[], const int Ai[], const std::complex< double > Ax[], void *Symbolic, void **Numeric, const double Control[UMFPACK_CONTROL], double Info [UMFPACK_INFO])
 
int umfpack_solve (int sys, const int Ap[], const int Ai[], const double Ax[], double X[], const double B[], void *Numeric, const double Control[UMFPACK_CONTROL], double Info[UMFPACK_INFO])
 
int umfpack_solve (int sys, const int Ap[], const int Ai[], const std::complex< double > Ax[], std::complex< double > X[], const std::complex< double > B[], void *Numeric, const double Control[UMFPACK_CONTROL], double Info[UMFPACK_INFO])
 
int umfpack_symbolic (int n_row, int n_col, const int Ap[], const int Ai[], const double Ax[], void **Symbolic, const double Control [UMFPACK_CONTROL], double Info [UMFPACK_INFO])
 
int umfpack_symbolic (int n_row, int n_col, const int Ap[], const int Ai[], const std::complex< double > Ax[], void **Symbolic, const double Control [UMFPACK_CONTROL], double Info [UMFPACK_INFO])
 
template<typename _Scalar , int _Options, typename _StorageIndex >
cholmod_sparse viewAsCholmod (Ref< SparseMatrix< _Scalar, _Options, _StorageIndex > > mat)
 
template<typename _Scalar , int _Options, typename _Index >
const cholmod_sparse viewAsCholmod (const SparseMatrix< _Scalar, _Options, _Index > &mat)
 
template<typename _Scalar , int _Options, typename _Index >
const cholmod_sparse viewAsCholmod (const SparseVector< _Scalar, _Options, _Index > &mat)
 
template<typename _Scalar , int _Options, typename _Index , unsigned int UpLo>
cholmod_sparse viewAsCholmod (const SparseSelfAdjointView< const SparseMatrix< _Scalar, _Options, _Index >, UpLo > &mat)
 
template<typename Derived >
cholmod_dense viewAsCholmod (MatrixBase< Derived > &mat)
 
template<typename Scalar , int Flags, typename StorageIndex >
MappedSparseMatrix< Scalar, Flags, StorageIndex > viewAsEigen (cholmod_sparse &cm)
 

Variables

const unsigned int ActualPacketAccessBit = 0x0
 
EIGEN_DEPRECATED const unsigned int AlignedBit = 0x80
 
const int CoherentAccessPattern = 0x1
 
const unsigned int CompressedAccessBit = 0x400
 
const unsigned int DirectAccessBit = 0x40
 
const int Dynamic = -1
 
const int DynamicIndex = 0xffffff
 
EIGEN_DEPRECATED const unsigned int EvalBeforeAssigningBit = 0x4
 
const unsigned int EvalBeforeNestingBit = 0x2
 
const unsigned int HereditaryBits
 
const int HugeCost = 10000
 
const int Infinity = -1
 
const int InnerRandomAccessPattern = 0x2 | CoherentAccessPattern
 
const unsigned int LinearAccessBit = 0x10
 
const unsigned int LvalueBit = 0x20
 
const unsigned int NestByRefBit = 0x100
 
const unsigned int NoPreferredStorageOrderBit = 0x200
 
const int OuterRandomAccessPattern = 0x4 | CoherentAccessPattern
 
const unsigned int PacketAccessBit = 0x8
 
const int RandomAccessPattern = 0x8 | OuterRandomAccessPattern | InnerRandomAccessPattern
 
const unsigned int RowMajorBit = 0x1
 

Typedef Documentation

◆ BlasIndex

typedef int Eigen::BlasIndex

Definition at line 119 of file MKL_support.h.

◆ dcomplex

typedef std::complex<double> Eigen::dcomplex

Definition at line 113 of file MKL_support.h.

◆ DenseIndex

Definition at line 25 of file Meta.h.

◆ Index

The Index type as used for the API.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

See also
TopicPreprocessorDirectives, StorageIndex.

Definition at line 33 of file Meta.h.

◆ scomplex

typedef std::complex<float> Eigen::scomplex

Definition at line 114 of file MKL_support.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
Large 
Small 

Definition at line 16 of file GeneralProduct.h.

◆ anonymous enum

anonymous enum
Enumerator
DontAlignCols 

Definition at line 16 of file IO.h.

◆ anonymous enum

anonymous enum
Enumerator
StreamPrecision 
FullPrecision 

Definition at line 17 of file IO.h.

◆ anonymous enum

anonymous enum
Enumerator
StandardCompressedFormat 

used by Ref<SparseMatrix> to specify whether the input storage must be in standard compressed form

Definition at line 15 of file SparseRef.h.

◆ Action

Enumerator
GetAction 
SetAction 

Definition at line 488 of file Constants.h.

◆ AmbiVectorMode

Enumerator
IsDense 
IsSparse 

Definition at line 356 of file Constants.h.

◆ CholmodMode

Enumerator
CholmodAuto 
CholmodSimplicialLLt 
CholmodSupernodalLLt 
CholmodLDLt 

Definition at line 162 of file CholmodSupport.h.

◆ Default_t

Enumerator
Default 

Definition at line 352 of file Constants.h.

◆ NoChange_t

Enumerator
NoChange 

Definition at line 350 of file Constants.h.

◆ ProductImplType

Enumerator
DefaultProduct 
LazyProduct 
AliasFreeProduct 
CoeffBasedProductMode 
LazyCoeffBasedProductMode 
OuterProduct 
InnerProduct 
GemvProduct 
GemmProduct 

Definition at line 483 of file Constants.h.

◆ Sequential_t

Enumerator
Sequential 

Definition at line 351 of file Constants.h.

◆ SimplicialCholeskyMode

Enumerator
SimplicialCholeskyLLT 
SimplicialCholeskyLDLT 

Definition at line 15 of file SimplicialCholesky.h.

◆ SpecializedType

Enumerator
Specialized 
BuiltIn 

Definition at line 310 of file Constants.h.

◆ TraversalType

Enumerator
DefaultTraversal 
LinearTraversal 
InnerVectorizedTraversal 
LinearVectorizedTraversal 
SliceVectorizedTraversal 
InvalidTraversal 
AllAtOnceTraversal 

Definition at line 276 of file Constants.h.

◆ UnrollingType

Enumerator
NoUnrolling 
InnerUnrolling 
CompleteUnrolling 

Definition at line 298 of file Constants.h.

Function Documentation

◆ EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE()

template<typename Derived >
const Eigen::EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE ( Derived  ,
typename Derived::Scalar  ,
pow   
) const
inline

Definition at line 113 of file GlobalFunctions.h.

◆ EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE()

template<typename Derived >
const Eigen::EIGEN_SCALAR_BINARYOP_EXPR_RETURN_TYPE ( typename Derived::Scalar  ,
Derived  ,
pow   
) const
inline

Definition at line 168 of file GlobalFunctions.h.

◆ householderSequence()

template<typename VectorsType , typename CoeffsType >
HouseholderSequence<VectorsType,CoeffsType> Eigen::householderSequence ( const VectorsType &  v,
const CoeffsType &  h 
)

Convenience function for constructing a Householder sequence.

\

Returns
A HouseholderSequence constructed from the specified arguments.

Definition at line 451 of file HouseholderSequence.h.

◆ initParallel()

void Eigen::initParallel ( )
inline

Must be call first when calling Eigen from multiple threads

Definition at line 48 of file Parallelizer.h.

◆ l1CacheSize()

std::ptrdiff_t Eigen::l1CacheSize ( )
inline
Returns
the currently set level 1 cpu cache size (in bytes) used to estimate the ideal blocking size parameters.
See also
setCpuCacheSize

Definition at line 2111 of file GeneralBlockPanelKernel.h.

◆ l2CacheSize()

std::ptrdiff_t Eigen::l2CacheSize ( )
inline
Returns
the currently set level 2 cpu cache size (in bytes) used to estimate the ideal blocking size parameters.
See also
setCpuCacheSize

Definition at line 2120 of file GeneralBlockPanelKernel.h.

◆ l3CacheSize()

std::ptrdiff_t Eigen::l3CacheSize ( )
inline
Returns
the currently set level 3 cpu cache size (in bytes) used to estimate the ideal blocking size paramete\ rs.
See also
setCpuCacheSize

Definition at line 2130 of file GeneralBlockPanelKernel.h.

◆ nbThreads()

int Eigen::nbThreads ( )
inline
Returns
the max number of threads reserved for Eigen
See also
setNbThreads

Definition at line 58 of file Parallelizer.h.

◆ operator*() [1/9]

template<typename SparseDerived , typename PermDerived >
const Product<SparseDerived, PermDerived, AliasFreeProduct> Eigen::operator* ( const SparseMatrixBase< SparseDerived > &  matrix,
const PermutationBase< PermDerived > &  perm 
)
inline
Returns
the matrix with the permutation applied to the columns

Definition at line 147 of file SparsePermutation.h.

◆ operator*() [2/9]

template<typename SparseDerived , typename PermDerived >
const Product<PermDerived, SparseDerived, AliasFreeProduct> Eigen::operator* ( const PermutationBase< PermDerived > &  perm,
const SparseMatrixBase< SparseDerived > &  matrix 
)
inline
Returns
the matrix with the permutation applied to the rows

Definition at line 154 of file SparsePermutation.h.

◆ operator*() [3/9]

template<typename SparseDerived , typename PermutationType >
const Product<SparseDerived, Inverse<PermutationType>, AliasFreeProduct> Eigen::operator* ( const SparseMatrixBase< SparseDerived > &  matrix,
const InverseImpl< PermutationType, PermutationStorage > &  tperm 
)
inline
Returns
the matrix with the inverse permutation applied to the columns.

Definition at line 162 of file SparsePermutation.h.

◆ operator*() [4/9]

template<typename SparseDerived , typename PermutationType >
const Product<Inverse<PermutationType>, SparseDerived, AliasFreeProduct> Eigen::operator* ( const InverseImpl< PermutationType, PermutationStorage > &  tperm,
const SparseMatrixBase< SparseDerived > &  matrix 
)
inline
Returns
the matrix with the inverse permutation applied to the rows.

Definition at line 171 of file SparsePermutation.h.

◆ operator*() [5/9]

template<typename MatrixDerived , typename TranspositionsDerived >
EIGEN_DEVICE_FUNC const Product<MatrixDerived, TranspositionsDerived, AliasFreeProduct> Eigen::operator* ( const MatrixBase< MatrixDerived > &  matrix,
const TranspositionsBase< TranspositionsDerived > &  transpositions 
)
Returns
the matrix with the transpositions applied to the columns.

Definition at line 338 of file Transpositions.h.

◆ operator*() [6/9]

template<typename TranspositionsDerived , typename MatrixDerived >
EIGEN_DEVICE_FUNC const Product<TranspositionsDerived, MatrixDerived, AliasFreeProduct> Eigen::operator* ( const TranspositionsBase< TranspositionsDerived > &  transpositions,
const MatrixBase< MatrixDerived > &  matrix 
)
Returns
the matrix with the transpositions applied to the rows.

Definition at line 350 of file Transpositions.h.

◆ operator*() [7/9]

template<typename OtherDerived , typename VectorsType , typename CoeffsType , int Side>
internal::matrix_type_times_scalar_type<typename VectorsType::Scalar,OtherDerived>::Type Eigen::operator* ( const MatrixBase< OtherDerived > &  other,
const HouseholderSequence< VectorsType, CoeffsType, Side > &  h 
)

Computes the product of a matrix with a Householder sequence.

Parameters
[in]otherMatrix being multiplied.
[in]hHouseholderSequence being multiplied.
Returns
Expression object representing the product.

This function computes $ MH $ where $ M $ is the matrix other and $ H $ is the Householder sequence represented by h.

Definition at line 438 of file HouseholderSequence.h.

◆ operator*() [8/9]

template<typename MatrixDerived , typename PermutationDerived >
EIGEN_DEVICE_FUNC const Product<MatrixDerived, PermutationDerived, AliasFreeProduct> Eigen::operator* ( const MatrixBase< MatrixDerived > &  matrix,
const PermutationBase< PermutationDerived > &  permutation 
)
Returns
the matrix with the permutation applied to the columns.

Definition at line 543 of file PermutationMatrix.h.

◆ operator*() [9/9]

template<typename PermutationDerived , typename MatrixDerived >
EIGEN_DEVICE_FUNC const Product<PermutationDerived, MatrixDerived, AliasFreeProduct> Eigen::operator* ( const PermutationBase< PermutationDerived > &  permutation,
const MatrixBase< MatrixDerived > &  matrix 
)
Returns
the matrix with the permutation applied to the rows.

Definition at line 555 of file PermutationMatrix.h.

◆ operator+() [1/2]

template<typename DenseDerived , typename SparseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_sum_op<typename DenseDerived::Scalar,typename SparseDerived::Scalar>, const DenseDerived, const SparseDerived> Eigen::operator+ ( const MatrixBase< DenseDerived > &  a,
const SparseMatrixBase< SparseDerived > &  b 
)

Definition at line 666 of file SparseCwiseBinaryOp.h.

◆ operator+() [2/2]

template<typename SparseDerived , typename DenseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_sum_op<typename SparseDerived::Scalar,typename DenseDerived::Scalar>, const SparseDerived, const DenseDerived> Eigen::operator+ ( const SparseMatrixBase< SparseDerived > &  a,
const MatrixBase< DenseDerived > &  b 
)

Definition at line 673 of file SparseCwiseBinaryOp.h.

◆ operator-() [1/2]

template<typename DenseDerived , typename SparseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_difference_op<typename DenseDerived::Scalar,typename SparseDerived::Scalar>, const DenseDerived, const SparseDerived> Eigen::operator- ( const MatrixBase< DenseDerived > &  a,
const SparseMatrixBase< SparseDerived > &  b 
)

Definition at line 680 of file SparseCwiseBinaryOp.h.

◆ operator-() [2/2]

template<typename SparseDerived , typename DenseDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_difference_op<typename SparseDerived::Scalar,typename DenseDerived::Scalar>, const SparseDerived, const DenseDerived> Eigen::operator- ( const SparseMatrixBase< SparseDerived > &  a,
const MatrixBase< DenseDerived > &  b 
)

Definition at line 687 of file SparseCwiseBinaryOp.h.

◆ rightHouseholderSequence()

template<typename VectorsType , typename CoeffsType >
HouseholderSequence<VectorsType,CoeffsType,OnTheRight> Eigen::rightHouseholderSequence ( const VectorsType &  v,
const CoeffsType &  h 
)

Convenience function for constructing a Householder sequence.

\

Returns
A HouseholderSequence constructed from the specified arguments.

This function differs from householderSequence() in that the template argument OnTheSide of the constructed HouseholderSequence is set to OnTheRight, instead of the default OnTheLeft.

Definition at line 463 of file HouseholderSequence.h.

◆ setCpuCacheSizes()

void Eigen::setCpuCacheSizes ( std::ptrdiff_t  l1,
std::ptrdiff_t  l2,
std::ptrdiff_t  l3 
)
inline

Set the cpu L1 and L2 cache sizes (in bytes). These values are use to adjust the size of the blocks for the algorithms working per blocks.

See also
computeProductBlockingSizes

Definition at line 2142 of file GeneralBlockPanelKernel.h.

◆ setNbThreads()

void Eigen::setNbThreads ( int  v)
inline

Sets the max number of threads reserved for Eigen

See also
nbThreads

Definition at line 67 of file Parallelizer.h.

◆ umfpack_defaults() [1/2]

void Eigen::umfpack_defaults ( double  control[UMFPACK_CONTROL],
double   
)
inline

Definition at line 20 of file UmfPackSupport.h.

◆ umfpack_defaults() [2/2]

void Eigen::umfpack_defaults ( double  control[UMFPACK_CONTROL],
std::complex< double >   
)
inline

Definition at line 23 of file UmfPackSupport.h.

◆ umfpack_free_numeric() [1/2]

void Eigen::umfpack_free_numeric ( void **  Numeric,
double   
)
inline

Definition at line 26 of file UmfPackSupport.h.

◆ umfpack_free_numeric() [2/2]

void Eigen::umfpack_free_numeric ( void **  Numeric,
std::complex< double >   
)
inline

Definition at line 29 of file UmfPackSupport.h.

◆ umfpack_free_symbolic() [1/2]

void Eigen::umfpack_free_symbolic ( void **  Symbolic,
double   
)
inline

Definition at line 32 of file UmfPackSupport.h.

◆ umfpack_free_symbolic() [2/2]

void Eigen::umfpack_free_symbolic ( void **  Symbolic,
std::complex< double >   
)
inline

Definition at line 35 of file UmfPackSupport.h.

◆ umfpack_get_determinant() [1/2]

int Eigen::umfpack_get_determinant ( double *  Mx,
double *  Ex,
void *  NumericHandle,
double  User_Info[UMFPACK_INFO] 
)
inline

Definition at line 106 of file UmfPackSupport.h.

◆ umfpack_get_determinant() [2/2]

int Eigen::umfpack_get_determinant ( std::complex< double > *  Mx,
double *  Ex,
void *  NumericHandle,
double  User_Info[UMFPACK_INFO] 
)
inline

Definition at line 111 of file UmfPackSupport.h.

◆ umfpack_get_lunz() [1/2]

int Eigen::umfpack_get_lunz ( int *  lnz,
int *  unz,
int *  n_row,
int *  n_col,
int *  nz_udiag,
void *  Numeric,
double   
)
inline

Definition at line 80 of file UmfPackSupport.h.

◆ umfpack_get_lunz() [2/2]

int Eigen::umfpack_get_lunz ( int *  lnz,
int *  unz,
int *  n_row,
int *  n_col,
int *  nz_udiag,
void *  Numeric,
std::complex< double >   
)
inline

Definition at line 85 of file UmfPackSupport.h.

◆ umfpack_get_numeric() [1/2]

int Eigen::umfpack_get_numeric ( int  Lp[],
int  Lj[],
double  Lx[],
int  Up[],
int  Ui[],
double  Ux[],
int  P[],
int  Q[],
double  Dx[],
int *  do_recip,
double  Rs[],
void *  Numeric 
)
inline

Definition at line 90 of file UmfPackSupport.h.

◆ umfpack_get_numeric() [2/2]

int Eigen::umfpack_get_numeric ( int  Lp[],
int  Lj[],
std::complex< double >  Lx[],
int  Up[],
int  Ui[],
std::complex< double >  Ux[],
int  P[],
int  Q[],
std::complex< double >  Dx[],
int *  do_recip,
double  Rs[],
void *  Numeric 
)
inline

Definition at line 96 of file UmfPackSupport.h.

◆ umfpack_numeric() [1/2]

int Eigen::umfpack_numeric ( const int  Ap[],
const int  Ai[],
const double  Ax[],
void *  Symbolic,
void **  Numeric,
const double  Control[UMFPACK_CONTROL],
double  Info[UMFPACK_INFO] 
)
inline

Definition at line 52 of file UmfPackSupport.h.

◆ umfpack_numeric() [2/2]

int Eigen::umfpack_numeric ( const int  Ap[],
const int  Ai[],
const std::complex< double >  Ax[],
void *  Symbolic,
void **  Numeric,
const double  Control[UMFPACK_CONTROL],
double  Info[UMFPACK_INFO] 
)
inline

Definition at line 59 of file UmfPackSupport.h.

◆ umfpack_solve() [1/2]

int Eigen::umfpack_solve ( int  sys,
const int  Ap[],
const int  Ai[],
const double  Ax[],
double  X[],
const double  B[],
void *  Numeric,
const double  Control[UMFPACK_CONTROL],
double  Info[UMFPACK_INFO] 
)
inline

Definition at line 66 of file UmfPackSupport.h.

◆ umfpack_solve() [2/2]

int Eigen::umfpack_solve ( int  sys,
const int  Ap[],
const int  Ai[],
const std::complex< double >  Ax[],
std::complex< double >  X[],
const std::complex< double >  B[],
void *  Numeric,
const double  Control[UMFPACK_CONTROL],
double  Info[UMFPACK_INFO] 
)
inline

Definition at line 73 of file UmfPackSupport.h.

◆ umfpack_symbolic() [1/2]

int Eigen::umfpack_symbolic ( int  n_row,
int  n_col,
const int  Ap[],
const int  Ai[],
const double  Ax[],
void **  Symbolic,
const double  Control[UMFPACK_CONTROL],
double  Info[UMFPACK_INFO] 
)
inline

Definition at line 38 of file UmfPackSupport.h.

◆ umfpack_symbolic() [2/2]

int Eigen::umfpack_symbolic ( int  n_row,
int  n_col,
const int  Ap[],
const int  Ai[],
const std::complex< double >  Ax[],
void **  Symbolic,
const double  Control[UMFPACK_CONTROL],
double  Info[UMFPACK_INFO] 
)
inline

Definition at line 45 of file UmfPackSupport.h.

◆ viewAsCholmod() [1/5]

template<typename _Scalar , int _Options, typename _StorageIndex >
cholmod_sparse Eigen::viewAsCholmod ( Ref< SparseMatrix< _Scalar, _Options, _StorageIndex > >  mat)

Wraps the Eigen sparse matrix mat into a Cholmod sparse matrix object. Note that the data are shared.

Definition at line 58 of file CholmodSupport.h.

◆ viewAsCholmod() [2/5]

template<typename _Scalar , int _Options, typename _Index >
const cholmod_sparse Eigen::viewAsCholmod ( const SparseMatrix< _Scalar, _Options, _Index > &  mat)

Definition at line 105 of file CholmodSupport.h.

◆ viewAsCholmod() [3/5]

template<typename _Scalar , int _Options, typename _Index >
const cholmod_sparse Eigen::viewAsCholmod ( const SparseVector< _Scalar, _Options, _Index > &  mat)

Definition at line 112 of file CholmodSupport.h.

◆ viewAsCholmod() [4/5]

template<typename _Scalar , int _Options, typename _Index , unsigned int UpLo>
cholmod_sparse Eigen::viewAsCholmod ( const SparseSelfAdjointView< const SparseMatrix< _Scalar, _Options, _Index >, UpLo > &  mat)

Returns a view of the Eigen sparse matrix mat as Cholmod sparse matrix. The data are not copied but shared.

Definition at line 121 of file CholmodSupport.h.

◆ viewAsCholmod() [5/5]

template<typename Derived >
cholmod_dense Eigen::viewAsCholmod ( MatrixBase< Derived > &  mat)

Returns a view of the Eigen dense matrix mat as Cholmod dense matrix. The data are not copied but shared.

Definition at line 134 of file CholmodSupport.h.

◆ viewAsEigen()

template<typename Scalar , int Flags, typename StorageIndex >
MappedSparseMatrix<Scalar,Flags,StorageIndex> Eigen::viewAsEigen ( cholmod_sparse &  cm)

Returns a view of the Cholmod sparse matrix cm as an Eigen sparse matrix. The data are not copied but shared.

Definition at line 155 of file CholmodSupport.h.

Variable Documentation

◆ ActualPacketAccessBit

const unsigned int Eigen::ActualPacketAccessBit = 0x0

Definition at line 102 of file Constants.h.

◆ CoherentAccessPattern

const int Eigen::CoherentAccessPattern = 0x1

Definition at line 47 of file SparseUtil.h.

◆ Dynamic

const int Eigen::Dynamic = -1

This value means that a positive quantity (e.g., a size) 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 21 of file Constants.h.

◆ DynamicIndex

const int Eigen::DynamicIndex = 0xffffff

This value means that a signed quantity (e.g., a signed index) is not known at compile-time, and that instead its value has to be specified at runtime.

Definition at line 26 of file Constants.h.

◆ HereditaryBits

const unsigned int Eigen::HereditaryBits
Initial value:
const unsigned int RowMajorBit
Definition: Constants.h:61
const unsigned int EvalBeforeNestingBit
Definition: Constants.h:65

Definition at line 190 of file Constants.h.

◆ HugeCost

const int Eigen::HugeCost = 10000

This value means that the cost to evaluate an expression coefficient is either very expensive or cannot be known at compile time.

This value has to be positive to (1) simplify cost computation, and (2) allow to distinguish between a very expensive and very very expensive expressions. It thus must also be large enough to make sure unrolling won't happen and that sub expressions will be evaluated, but not too large to avoid overflow.

Definition at line 39 of file Constants.h.

◆ Infinity

const int Eigen::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 31 of file Constants.h.

◆ InnerRandomAccessPattern

const int Eigen::InnerRandomAccessPattern = 0x2 | CoherentAccessPattern

Definition at line 48 of file SparseUtil.h.

◆ NestByRefBit

const unsigned int Eigen::NestByRefBit = 0x100

Definition at line 164 of file Constants.h.

◆ OuterRandomAccessPattern

const int Eigen::OuterRandomAccessPattern = 0x4 | CoherentAccessPattern

Definition at line 49 of file SparseUtil.h.

◆ RandomAccessPattern

const int Eigen::RandomAccessPattern = 0x8 | OuterRandomAccessPattern | InnerRandomAccessPattern

Definition at line 50 of file SparseUtil.h.



co_scan
Author(s):
autogenerated on Mon Feb 28 2022 23:00:58