Detailed Description

Namespace containing all symbols from the Eigen library.

Namespaces
namespace	Architecture
namespace	internal
	Applies the clock wise 2D rotation j to the set of 2D vectors of cordinates x and y: $\left ( \begin{array}{cc} x \\ y \end{array} \right ) = J \left ( \begin{array}{cc} x \\ y \end{array} \right )$
Classes
class	LLT
	Standard Cholesky decomposition (LL^T) of a matrix and associated features. More...
class	LDLT
	Robust Cholesky decomposition of a matrix with pivoting. More...
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...
class	aligned_allocator
	STL compatible allocator to use with with 16 byte aligned types. More...
struct	GenericNumTraits
class	NumTraits
	Holds information about the various numeric (i.e. More...
struct	NumTraits< float >
struct	NumTraits< double >
struct	NumTraits< long double >
struct	NumTraits< std::complex< _Real > >
struct	NumTraits< Array< Scalar, Rows, Cols, Options, MaxRows, MaxCols > >
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...
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	DenseBase
	Base class for all dense matrices, vectors, and arrays. More...
class	MatrixBase
	Base class for all dense matrices, vectors, and expressions. More...
struct	EigenBase
	Common base class for all classes T such that MatrixBase has an operator=(T) and a constructor MatrixBase(T). More...
class	DenseStorage
class	DenseStorage< T, 0, _Rows, _Cols, _Options >
class	DenseStorage< T, 0, Dynamic, Dynamic, _Options >
class	DenseStorage< T, 0, _Rows, Dynamic, _Options >
class	DenseStorage< T, 0, Dynamic, _Cols, _Options >
class	DenseStorage< T, Size, Dynamic, Dynamic, _Options >
class	DenseStorage< T, Size, Dynamic, _Cols, _Options >
class	DenseStorage< T, Size, _Rows, Dynamic, _Options >
class	DenseStorage< T, Dynamic, Dynamic, Dynamic, _Options >
class	DenseStorage< T, Dynamic, _Rows, Dynamic, _Options >
class	DenseStorage< T, Dynamic, Dynamic, _Cols, _Options >
class	NestByValue
	Expression which must be nested by value. More...
class	ForceAlignedAccess
	Enforce aligned packet loads and stores regardless of what is requested. More...
class	ReturnByValue
class	NoAlias
	Pseudo expression providing an operator = assuming no aliasing. More...
class	PlainObjectBase
	Dense storage base class for matrices and arrays. More...
class	Matrix
	The matrix class, also used for vectors and row-vectors. More...
class	Array
	General-purpose arrays with easy API for coefficient-wise operations. More...
class	CwiseBinaryOp
	Generic expression where a coefficient-wise binary operator is applied to two expressions. More...
class	CwiseBinaryOpImpl< BinaryOp, Lhs, Rhs, Dense >
class	CwiseUnaryOp
	Generic expression where a coefficient-wise unary operator is applied to an expression. More...
class	CwiseUnaryOpImpl< UnaryOp, XprType, Dense >
class	CwiseNullaryOp
	Generic expression of a matrix where all coefficients are defined by a functor. More...
class	CwiseUnaryView
	Generic lvalue expression of a coefficient-wise unary operator of a matrix or a vector. More...
class	CwiseUnaryViewImpl< ViewOp, MatrixType, Dense >
class	SelfCwiseBinaryOp
class	MapBase< Derived, ReadOnlyAccessors >
class	MapBase< Derived, WriteAccessors >
class	Stride
	Holds strides information for Map. More...
class	InnerStride
	Convenience specialization of Stride to specify only an inner stride See class Map for some examples. More...
class	OuterStride
	Convenience specialization of Stride to specify only an outer stride See class Map for some examples. More...
class	Map
	A matrix or vector expression mapping an existing array of data. More...
class	Block
	Expression of a fixed-size or dynamic-size block. More...
class	Block< XprType, BlockRows, BlockCols, InnerPanel, true >
class	VectorBlock
	Expression of a fixed-size or dynamic-size sub-vector. More...
class	Transpose
	Expression of the transpose of a matrix. More...
class	TransposeImpl< MatrixType, Dense >
class	DiagonalMatrix
	Represents a diagonal matrix with its storage. More...
class	DiagonalWrapper
	Expression of a diagonal matrix. More...
class	Diagonal
	Expression of a diagonal/subdiagonal/superdiagonal in a matrix. More...
class	DiagonalProduct
class	PermutationBase
	Base class for permutations. More...
class	PermutationMatrix
	Permutation matrix. More...
class	Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >
struct	PermutationStorage
class	PermutationWrapper
	Class to view a vector of integers as a permutation matrix. More...
class	Transpose< PermutationBase< Derived > >
class	TranspositionsBase
class	Transpositions
	Represents a sequence of transpositions (row/column interchange) More...
class	Map< Transpositions< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, PacketAccess >
class	TranspositionsWrapper
class	Transpose< TranspositionsBase< TranspositionsDerived > >
class	IOFormat
	Stores a set of parameters controlling the way matrices are printed. More...
class	WithFormat
	Pseudo expression providing matrix output with given format. More...
class	SwapWrapper
class	CommaInitializer
	Helper class used by the comma initializer operator. More...
class	Flagged
	Expression with modified flags. More...
class	ProductBase
class	ScaledProduct
class	ProductReturnType
	Helper class to get the correct and optimized returned type of operator*. More...
struct	ProductReturnType< Lhs, Rhs, CoeffBasedProductMode >
struct	ProductReturnType< Lhs, Rhs, LazyCoeffBasedProductMode >
struct	LazyProductReturnType
class	GeneralProduct< Lhs, Rhs, InnerProduct >
class	GeneralProduct< Lhs, Rhs, OuterProduct >
class	GeneralProduct< Lhs, Rhs, GemvProduct >
class	TriangularBase
class	TriangularView
	Base class for triangular part in a matrix. More...
class	SelfAdjointView
	Expression of a selfadjoint matrix from a triangular part of a dense matrix. More...
class	CoeffBasedProduct
class	GeneralProduct< Lhs, Rhs, GemmProduct >
struct	SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true >
struct	SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false >
struct	SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false >
struct	selfadjoint_rank1_update< Scalar, Index, ColMajor, UpLo, ConjLhs, ConjRhs >
struct	selfadjoint_rank1_update< Scalar, Index, RowMajor, UpLo, ConjLhs, ConjRhs >
struct	selfadjoint_product_selector< MatrixType, OtherType, UpLo, true >
struct	selfadjoint_product_selector< MatrixType, OtherType, UpLo, false >
struct	TriangularProduct< Mode, true, Lhs, false, Rhs, true >
struct	TriangularProduct< Mode, false, Lhs, true, Rhs, false >
struct	TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false >
class	Select
	Expression of a coefficient wise version of the C++ ternary operator ?: More...
class	PartialReduxExpr
	Generic expression of a partially reduxed matrix. More...
class	VectorwiseOp
	Pseudo expression providing partial reduction operations. More...
class	Replicate
	Expression of the multiple replication of a matrix or vector. More...
class	Reverse
	Expression of the reverse of a vector or matrix. 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...
class	MatrixWrapper
	Expression of an array as a mathematical vector or matrix. More...
class	Tridiagonalization
	More...
class	HessenbergDecomposition
	More...
class	RealSchur
	More...
class	EigenSolver
	More...
class	SelfAdjointEigenSolver
	More...
class	GeneralizedSelfAdjointEigenSolver
	More...
class	ComplexSchur
	More...
class	ComplexEigenSolver
	More...
class	Homogeneous
	More...
class	RotationBase
	Common base class for compact rotation representations. More...
class	Rotation2D
	More...
class	QuaternionBase
class	Quaternion
	More...
class	Map< const Quaternion< _Scalar >, _Options >
	Quaternion expression mapping a constant memory buffer. More...
class	Map< Quaternion< _Scalar >, _Options >
	Expression of a quaternion from a memory buffer. More...
class	AngleAxis
	More...
class	Transform
	More...
class	Translation
	More...
class	UniformScaling
class	Hyperplane
	More...
class	ParametrizedLine
	More...
class	AlignedBox
	More...
class	HouseholderSequence
	More...
class	JacobiRotation
	More...
class	FullPivLU
	LU decomposition of a matrix with complete pivoting, and related features. More...
class	PartialPivLU
	LU decomposition of a matrix with partial pivoting, and related features. More...
class	HouseholderQR
	Householder QR decomposition of a matrix. More...
class	FullPivHouseholderQR
	Householder rank-revealing QR decomposition of a matrix with full pivoting. More...
class	ColPivHouseholderQR
	Householder rank-revealing QR decomposition of a matrix with column-pivoting. More...
struct	Sparse
	The type used to identify a general sparse storage. More...
class	SparseMatrixBase
	Base class of any sparse matrices or sparse expressions. More...
class	CompressedStorage
	Stores a sparse set of values as a list of values and a list of indices. More...
class	AmbiVector
class	SparseMatrix
	The main sparse matrix class. More...
class	DynamicSparseMatrix
	A sparse matrix class designed for matrix assembly purpose. More...
class	MappedSparseMatrix
	Sparse matrix. More...
class	SparseVector
	a sparse vector class More...
class	SparseInnerVectorSet
class	SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options, _Index >, Size >
class	SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >
class	TransposeImpl< MatrixType, Sparse >
class	CwiseUnaryOpImpl< UnaryOp, MatrixType, Sparse >
class	CwiseUnaryViewImpl< ViewOp, MatrixType, Sparse >
class	CwiseBinaryOpImpl< BinaryOp, Lhs, Rhs, Sparse >
struct	SparseSparseProductReturnType
class	SparseSparseProduct
struct	SparseDenseProductReturnType
struct	SparseDenseProductReturnType< Lhs, Rhs, 1 >
struct	DenseSparseProductReturnType
struct	DenseSparseProductReturnType< Lhs, Rhs, 1 >
class	SparseDenseOuterProduct
class	SparseTimeDenseProduct
class	DenseTimeSparseProduct
class	SparseDiagonalProduct
class	SparseTriangularView
class	SparseSelfAdjointView
	Pseudo expression to manipulate a triangular sparse matrix as a selfadjoint matrix. More...
class	SparseSelfAdjointTimeDenseProduct
class	DenseTimeSparseSelfAdjointProduct
class	SparseSymmetricPermutationProduct
class	SparseView
class	JacobiSVD
	Two-sided Jacobi SVD decomposition of a rectangular matrix. More...
Typedefs
typedef EIGEN_DEFAULT_DENSE_INDEX_TYPE	DenseIndex
typedef Rotation2D< float >	Rotation2Df
	single precision 2D rotation type
typedef Rotation2D< double >	Rotation2Dd
	double precision 2D rotation type
typedef Quaternion< float >	Quaternionf
	single precision quaternion type
typedef Quaternion< double >	Quaterniond
	double precision quaternion type
typedef Map< Quaternion< float >, 0 >	QuaternionMapf
	Map an unaligned array of single precision scalar as a quaternion.
typedef Map< Quaternion < double >, 0 >	QuaternionMapd
	Map an unaligned array of double precision scalar as a quaternion.
typedef Map< Quaternion< float > , Aligned >	QuaternionMapAlignedf
	Map a 16-bits aligned array of double precision scalars as a quaternion.
typedef Map< Quaternion < double >, Aligned >	QuaternionMapAlignedd
	Map a 16-bits aligned array of double precision scalars as a quaternion.
typedef AngleAxis< float >	AngleAxisf
	single precision angle-axis type
typedef AngleAxis< double >	AngleAxisd
	double precision angle-axis type
typedef Transform< float, 2, Isometry >	Isometry2f
typedef Transform< float, 3, Isometry >	Isometry3f
typedef Transform< double, 2, Isometry >	Isometry2d
typedef Transform< double, 3, Isometry >	Isometry3d
typedef Transform< float, 2, Affine >	Affine2f
typedef Transform< float, 3, Affine >	Affine3f
typedef Transform< double, 2, Affine >	Affine2d
typedef Transform< double, 3, Affine >	Affine3d
typedef Transform< float, 2, AffineCompact >	AffineCompact2f
typedef Transform< float, 3, AffineCompact >	AffineCompact3f
typedef Transform< double, 2, AffineCompact >	AffineCompact2d
typedef Transform< double, 3, AffineCompact >	AffineCompact3d
typedef Transform< float, 2, Projective >	Projective2f
typedef Transform< float, 3, Projective >	Projective3f
typedef Transform< double, 2, Projective >	Projective2d
typedef Transform< double, 3, Projective >	Projective3d
typedef Translation< float, 2 >	Translation2f
typedef Translation< double, 2 >	Translation2d
typedef Translation< float, 3 >	Translation3f
typedef Translation< double, 3 >	Translation3d
typedef DiagonalMatrix< float, 2 >	AlignedScaling2f
typedef DiagonalMatrix< double, 2 >	AlignedScaling2d
typedef DiagonalMatrix< float, 3 >	AlignedScaling3f
typedef DiagonalMatrix< double, 3 >	AlignedScaling3d
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 containing possible values for the `Mode` parameter of MatrixBase::selfadjointView() and MatrixBase::triangularView(). More...
enum	{ Unaligned = 0, Aligned = 1 }
	Enum for indicating whether an object is aligned or not. More...
enum	CornerType { TopLeft, TopRight, BottomLeft, BottomRight }
	Enum used by DenseBase::corner() in Eigen2 compatibility mode. More...
enum	DirectionType { Vertical, Horizontal, BothDirections }
	Enum containing possible values for the `Direction` parameter of Reverse, PartialReduxExpr and VectorwiseOp. More...
enum	{ DefaultTraversal, LinearTraversal, InnerVectorizedTraversal, LinearVectorizedTraversal, SliceVectorizedTraversal, InvalidTraversal }
enum	{ NoUnrolling, InnerUnrolling, CompleteUnrolling }
enum	{ ColMajor = 0, RowMajor = 0x1, AutoAlign = 0, DontAlign = 0x2 }
	Enum containing possible values for the `_Options` template parameter of Matrix, Array and BandMatrix. More...
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 }
	Used as template parameter in DenseCoeffBase and MapBase to indicate which accessors should be provided. More...
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 with options to give to various decompositions. More...
enum	QRPreconditioners { NoQRPreconditioner, HouseholderQRPreconditioner, ColPivHouseholderQRPreconditioner, FullPivHouseholderQRPreconditioner }
	Possible values for the `QRPreconditioner` template parameter of JacobiSVD. More...
enum	ComputationInfo { Success = 0, NumericalIssue = 1, NoConvergence = 2 }
	enums Enum for reporting the status of a computation. More...
enum	TransformTraits { Isometry = 0x1, Affine = 0x2, AffineCompact = 0x10 \| Affine, Projective = 0x20 }
	Enum used to specify how a particular transformation is stored in a matrix. More...
enum	{ CoeffBasedProductMode, LazyCoeffBasedProductMode, OuterProduct, InnerProduct, GemvProduct, GemmProduct }
enum	Action { GetAction, SetAction }
enum	{ DontAlignCols = 1 }
enum	{ StreamPrecision = -1, FullPrecision = -2 }
enum	{ Large = 2, Small = 3 }
Functions
static const char *	SimdInstructionSetsInUse (void)
template<typename Derived , typename PermutationDerived >
const internal::permut_matrix_product_retval < PermutationDerived, Derived, OnTheRight >	operator* (const MatrixBase< Derived > &matrix, const PermutationBase< PermutationDerived > &permutation)
template<typename Derived , typename PermutationDerived >
const internal::permut_matrix_product_retval < PermutationDerived, Derived, OnTheLeft >	operator* (const PermutationBase< PermutationDerived > &permutation, const MatrixBase< Derived > &matrix)
template<typename Derived , typename TranspositionsDerived >
const internal::transposition_matrix_product_retval < TranspositionsDerived, Derived, OnTheRight >	operator* (const MatrixBase< Derived > &matrix, const TranspositionsBase< TranspositionsDerived > &transpositions)
template<typename Derived , typename TranspositionDerived >
const internal::transposition_matrix_product_retval < TranspositionDerived, Derived, OnTheLeft >	operator* (const TranspositionsBase< TranspositionDerived > &transpositions, const MatrixBase< Derived > &matrix)
template<typename Derived , typename Lhs , typename Rhs >
const ScaledProduct< Derived >	operator* (const ProductBase< Derived, Lhs, Rhs > &prod, typename Derived::Scalar x)
template<typename Derived , typename Lhs , typename Rhs >
internal::enable_if <!internal::is_same< typename Derived::Scalar, typename Derived::RealScalar >::value, const ScaledProduct< Derived > >::type	operator* (const ProductBase< Derived, Lhs, Rhs > &prod, typename Derived::RealScalar x)
template<typename Derived , typename Lhs , typename Rhs >
const ScaledProduct< Derived >	operator* (typename Derived::Scalar x, const ProductBase< Derived, Lhs, Rhs > &prod)
template<typename Derived , typename Lhs , typename Rhs >
internal::enable_if <!internal::is_same< typename Derived::Scalar, typename Derived::RealScalar >::value, const ScaledProduct< Derived > >::type	operator* (typename Derived::RealScalar x, const ProductBase< Derived, Lhs, Rhs > &prod)
std::ptrdiff_t	l1CacheSize ()
std::ptrdiff_t	l2CacheSize ()
void	setCpuCacheSizes (std::ptrdiff_t l1, std::ptrdiff_t l2)
	Set the cpu L1 and L2 cache sizes (in bytes).
template<typename Scalar >
std::complex< Scalar >	cdiv (Scalar xr, Scalar xi, Scalar yr, Scalar yi)
static UniformScaling< float >	Scaling (float s)
	Constructs a uniform scaling from scale factor s.
static UniformScaling< double >	Scaling (double s)
	Constructs a uniform scaling from scale factor s.
template<typename RealScalar >
static UniformScaling < std::complex< RealScalar > >	Scaling (const std::complex< RealScalar > &s)
	Constructs a uniform scaling from scale factor s.
template<typename Scalar >
static DiagonalMatrix< Scalar, 2 >	Scaling (Scalar sx, Scalar sy)
	Constructs a 2D axis aligned scaling.
template<typename Scalar >
static DiagonalMatrix< Scalar, 3 >	Scaling (Scalar sx, Scalar sy, Scalar sz)
	Constructs a 3D axis aligned scaling.
template<typename Derived >
static const DiagonalWrapper < const Derived >	Scaling (const MatrixBase< Derived > &coeffs)
	Constructs an axis aligned scaling expression from vector expression coeffs This is an alias for coeffs.asDiagonal()
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)

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.
template<typename VectorsType , typename CoeffsType >
HouseholderSequence < VectorsType, CoeffsType >	householderSequence (const VectorsType &v, const CoeffsType &h)
	\
template<typename VectorsType , typename CoeffsType >
HouseholderSequence < VectorsType, CoeffsType, OnTheRight >	rightHouseholderSequence (const VectorsType &v, const CoeffsType &h)
	\
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
const int	CoherentAccessPattern = 0x1
const int	InnerRandomAccessPattern = 0x2 \| CoherentAccessPattern
const int	OuterRandomAccessPattern = 0x4 \| CoherentAccessPattern
const int	RandomAccessPattern = 0x8 \| OuterRandomAccessPattern \| InnerRandomAccessPattern

Typedef Documentation

typedef EIGEN_DEFAULT_DENSE_INDEX_TYPE Eigen::DenseIndex

Definition at line 41 of file Core.

Enumeration Type Documentation

anonymous enum

Enumerator:

DefaultTraversal
LinearTraversal
InnerVectorizedTraversal
LinearVectorizedTraversal
SliceVectorizedTraversal
InvalidTraversal

Definition at line 231 of file Core.

anonymous enum

Enumerator:

NoUnrolling
InnerUnrolling
CompleteUnrolling

Definition at line 251 of file Core.

anonymous enum

Enumerator:

IsDense
IsSparse

Definition at line 307 of file Core.

anonymous enum

Enumerator:

CoeffBasedProductMode
LazyCoeffBasedProductMode
OuterProduct
InnerProduct
GemvProduct
GemmProduct

Definition at line 425 of file Core.

anonymous enum

Enumerator:

DontAlignCols

Definition at line 30 of file Core.

anonymous enum

Enumerator:

StreamPrecision
FullPrecision

Definition at line 31 of file Core.

anonymous enum

Enumerator:

Large
Small

Definition at line 52 of file Core.

enum Eigen::Action

Enumerator:

GetAction
SetAction

Definition at line 429 of file Core.

enum Eigen::ComputationInfo

enums 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 381 of file Core.

Function Documentation

template<typename Scalar >

std::complex<Scalar> Eigen::cdiv	(	Scalar	xr,
		Scalar	xi,
		Scalar	yr,
		Scalar	yi
	)

Definition at line 410 of file Eigenvalues.

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 1260 of file Core.

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 1269 of file Core.

template<typename Derived , typename Lhs , typename Rhs >

const ScaledProduct<Derived> Eigen::operator*	(	const ProductBase< Derived, Lhs, Rhs > &	prod,
		typename Derived::Scalar	x
	)

Definition at line 210 of file Core.

template<typename Derived , typename Lhs , typename Rhs >

internal::enable_if<!internal::is_same<typename Derived::Scalar,typename Derived::RealScalar>::value, const ScaledProduct<Derived> >::type Eigen::operator*	(	const ProductBase< Derived, Lhs, Rhs > &	prod,
		typename Derived::RealScalar	x
	)

Definition at line 216 of file Core.

template<typename Derived , typename Lhs , typename Rhs >

const ScaledProduct<Derived> Eigen::operator*	(	typename Derived::Scalar	x,
		const ProductBase< Derived, Lhs, Rhs > &	prod
	)

Definition at line 222 of file Core.

template<typename Derived , typename Lhs , typename Rhs >

internal::enable_if<!internal::is_same<typename Derived::Scalar,typename Derived::RealScalar>::value, const ScaledProduct<Derived> >::type Eigen::operator*	(	typename Derived::RealScalar	x,
		const ProductBase< Derived, Lhs, Rhs > &	prod
	)

Definition at line 228 of file Core.

template<typename Derived , typename TranspositionsDerived >

const internal::transposition_matrix_product_retval<TranspositionsDerived, Derived, OnTheRight> Eigen::operator*	(	const MatrixBase< Derived > &	matrix,
		const TranspositionsBase< TranspositionsDerived > &	transpositions
	)		`[inline]`

Returns:: the matrix with the transpositions applied to the columns.

Definition at line 345 of file Core.

template<typename Derived , typename TranspositionDerived >

const internal::transposition_matrix_product_retval<TranspositionDerived, Derived, OnTheLeft> Eigen::operator*	(	const TranspositionsBase< TranspositionDerived > &	transpositions,
		const MatrixBase< Derived > &	matrix
	)		`[inline]`

Returns:: the matrix with the transpositions applied to the rows.

Definition at line 358 of file Core.

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]	other	Matrix being multiplied.
[in]	h	HouseholderSequence 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 400 of file Householder.

template<typename Derived , typename PermutationDerived >

const internal::permut_matrix_product_retval<PermutationDerived, Derived, OnTheRight> Eigen::operator*	(	const MatrixBase< Derived > &	matrix,
		const PermutationBase< PermutationDerived > &	permutation
	)		`[inline]`

Returns:: the matrix with the permutation applied to the columns.

Definition at line 522 of file Core.

template<typename Derived , typename PermutationDerived >

const internal::permut_matrix_product_retval<PermutationDerived, Derived, OnTheLeft> Eigen::operator*	(	const PermutationBase< PermutationDerived > &	permutation,
		const MatrixBase< Derived > &	matrix
	)		`[inline]`

Returns:: the matrix with the permutation applied to the rows.

Definition at line 535 of file Core.

static UniformScaling<float> Eigen::Scaling ( float s ) [inline, static]

Constructs a uniform scaling from scale factor s.

Definition at line 124 of file Geometry.

static UniformScaling<double> Eigen::Scaling ( double s ) [inline, static]

Constructs a uniform scaling from scale factor s.

Definition at line 126 of file Geometry.

template<typename RealScalar >

static UniformScaling<std::complex<RealScalar> > Eigen::Scaling ( const std::complex< RealScalar > & s ) [inline, static]

Constructs a uniform scaling from scale factor s.

Definition at line 129 of file Geometry.

template<typename Scalar >

static DiagonalMatrix<Scalar,2> Eigen::Scaling	(	Scalar	sx,
		Scalar	sy
	)		`[inline, static]`

Constructs a 2D axis aligned scaling.

Definition at line 134 of file Geometry.

template<typename Scalar >

static DiagonalMatrix<Scalar,3> Eigen::Scaling	(	Scalar	sx,
		Scalar	sy,
		Scalar	sz
	)		`[inline, static]`

Constructs a 3D axis aligned scaling.

Definition at line 138 of file Geometry.

template<typename Derived >

static const DiagonalWrapper<const Derived> Eigen::Scaling ( const MatrixBase< Derived > & coeffs ) [inline, static]

Constructs an axis aligned scaling expression from vector expression coeffs This is an alias for coeffs.asDiagonal()

Definition at line 145 of file Geometry.

void Eigen::setCpuCacheSizes	(	std::ptrdiff_t	l1,
		std::ptrdiff_t	l2
	)		`[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 1281 of file Core.

static const char* Eigen::SimdInstructionSetsInUse ( void ) [inline, static]

Definition at line 191 of file Core.

Variable Documentation

const unsigned int Eigen::ActualPacketAccessBit = 0x0

Definition at line 105 of file Core.

const int Eigen::CoherentAccessPattern = 0x1

Definition at line 79 of file Sparse.

const int Eigen::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 35 of file Core.

Referenced by setSize(), Eigen::MatrixBase::fromMatlabStringFormat(), and Eigen::MatrixBase::loadFromTextFile().

const unsigned int Eigen::HereditaryBits

Initial value:

 RowMajorBit
                                  | EvalBeforeNestingBit
                                  | EvalBeforeAssigningBit

Definition at line 163 of file Core.

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 40 of file Core.

const int Eigen::InnerRandomAccessPattern = 0x2 | CoherentAccessPattern

Definition at line 80 of file Sparse.

const unsigned int Eigen::NestByRefBit = 0x100

Definition at line 160 of file Core.

const int Eigen::OuterRandomAccessPattern = 0x4 | CoherentAccessPattern

Definition at line 81 of file Sparse.

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

Definition at line 82 of file Sparse.

Detailed Description

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation