diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index dbbdb0670..c90c9e9ce 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -13,17 +13,17 @@ The Eigen library is divided in a Core module and several additional modules. Ea
Module | Header file | Contents |
---|---|---|
\link Core_Module Core \endlink | \code#include | Matrix and Array classes, basic linear algebra (including triangular and selfadjoint products), array manipulation |
\link Core_Module Core \endlink | \code#include | Matrix and Array classes, basic linear algebra (including triangular and selfadjoint products), array manipulation |
\link Geometry_Module Geometry \endlink | \code#include | Transform, Translation, Scaling, Rotation2D and 3D rotations (Quaternion, AngleAxis) |
\link LU_Module LU \endlink | \code#include | Inverse, determinant, LU decompositions with solver (FullPivLU, PartialPivLU) |
\link Cholesky_Module Cholesky \endlink | \code#include | LLT and LDLT Cholesky factorization with solver |
\link Householder_Module Householder \endlink | \code#include | Householder transformations; this module is used by several linear algebra modules |
\link SVD_Module SVD \endlink | \code#include | SVD decomposition with least-squares solver (JacobiSVD) |
\link QR_Module QR \endlink | \code#include | QR decomposition with solver (HouseholderQR, ColPivHouseholderQR, FullPivHouseholderQR) |
\link Eigenvalues_Module Eigenvalues \endlink | \code#include | Eigenvalue, eigenvector decompositions (EigenSolver, SelfAdjointEigenSolver, ComplexEigenSolver) |
\link Sparse_modules Sparse \endlink | \code#include | %Sparse matrix storage and related basic linear algebra (SparseMatrix, DynamicSparseMatrix, SparseVector) |
\code#include | Includes Core, Geometry, LU, Cholesky, SVD, QR, and Eigenvalues header files | |
\code#include | Includes %Dense and %Sparse header files (the whole Eigen library) | |
\link LU_Module LU \endlink | \code#include | Inverse, determinant, LU decompositions with solver (FullPivLU, PartialPivLU) |
\link Cholesky_Module Cholesky \endlink | \code#include | LLT and LDLT Cholesky factorization with solver |
\link Householder_Module Householder \endlink | \code#include | Householder transformations; this module is used by several linear algebra modules |
\link SVD_Module SVD \endlink | \code#include | SVD decompositions with least-squares solver (JacobiSVD, BDCSVD) |
\link QR_Module QR \endlink | \code#include | QR decomposition with solver (HouseholderQR, ColPivHouseholderQR, FullPivHouseholderQR) |
\link Eigenvalues_Module Eigenvalues \endlink | \code#include | Eigenvalue, eigenvector decompositions (EigenSolver, SelfAdjointEigenSolver, ComplexEigenSolver) |
\link Sparse_modules Sparse \endlink | \code#include | %Sparse matrix storage and related basic linear algebra (SparseMatrix, SparseVector) \n (see \ref SparseQuickRefPage for details on sparse modules) |
\code#include | Includes Core, Geometry, LU, Cholesky, SVD, QR, and Eigenvalues header files | |
\code#include | Includes %Dense and %Sparse header files (the whole Eigen library) |