From 49747fa4a983cbd5b383a5b8054b8452437ff614 Mon Sep 17 00:00:00 2001 From: Jitse Niesen Date: Tue, 6 Jul 2010 13:10:08 +0100 Subject: Various documentation improvements. * Add short documentation for Array class * Put all classes explicitly in Core module (where applicable) * Section on Modules in Quick Reference Guide * Put Page 7 after Page 6 in Contents :) --- doc/QuickReference.dox | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) (limited to 'doc/QuickReference.dox') diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index 1ded32a5f..edd00988d 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -18,18 +18,21 @@ namespace Eigen { top \section QuickRef_Headers Modules and Header files +The Eigen library is divided in a Core module and several additional modules. Each module has a corresponding header file which has to be included in order to use the module. The \c %Dense and \c Eigen header files are provided to conveniently gain access to several modules at once. + - - - - - - - - - - + + + + + + + + + + +
ModuleHeader fileContents
Core\code#include \endcodeMatrix and Array classes, basic linear algebra (including triangular and selfadjoint products), array manipulation
Geometry\code#include \endcodeTransformation, Translation, Scaling, 2D and 3D rotations (Quaternion, AngleAxis)
LU\code#include \endcodeInverse, determinant, LU decompositions (FullPivLU, PartialPivLU) with solver
Cholesky\code#include \endcodeLLT and LDLT Cholesky factorization with solver
SVD\code#include \endcodeSVD decomposition with solver (HouseholderSVD, JacobiSVD)
QR\code#include \endcodeQR decomposition with solver (HouseholderQR, ColPivHouseholerQR, FullPivHouseholderQR)
Eigenvalues\code#include \endcodeEigenvalue, eigenvector decompositions for selfadjoint and non selfadjoint real or complex matrices.
Sparse\code#include \endcodeSparse matrix storage and related basic linear algebra.
\code#include \endcodeIncludes Core, Geometry, LU, Cholesky, SVD, QR, and Eigenvalues
\code#include \endcodeIncludes Dense and Sparse
\link Core_Module Core \endlink\code#include \endcodeMatrix and Array classes, basic linear algebra (including triangular and selfadjoint products), array manipulation
\link Geometry_Module Geometry \endlink\code#include \endcodeTransform, Translation, Scaling, Rotation2D and 3D rotations (Quaternion, AngleAxis)
\link LU_Module LU \endlink\code#include \endcodeInverse, determinant, LU decompositions with solver (FullPivLU, PartialPivLU)
\link Cholesky_Module Cholesky \endlink\code#include \endcodeLLT and LDLT Cholesky factorization with solver
\link Householder_Module Householder \endlink\code#include \endcodeHouseholder transformations; this module is used by several linear algebra modules
\link SVD_Module SVD \endlink\code#include \endcode%SVD decomposition with solver (SVD, JacobiSVD)
\link QR_Module QR \endlink\code#include \endcodeQR decomposition with solver (HouseholderQR, ColPivHouseholderQR, FullPivHouseholderQR)
\link Eigenvalues_Module Eigenvalues \endlink\code#include \endcodeEigenvalue, eigenvector decompositions (EigenSolver, SelfAdjointEigenSolver, ComplexEigenSolver)
\link Sparse_Module Sparse \endlink\code#include \endcode%Sparse matrix storage and related basic linear algebra (SparseMatrix, DynamicSparseMatrix, SparseVector)
\code#include \endcodeIncludes Core, Geometry, LU, Cholesky, %SVD, QR, and Eigenvalues header files
\code#include \endcodeIncludes %Dense and %Sparse header files (the whole Eigen library)
top @@ -486,7 +489,7 @@ Read-write access to sub-vectors: \code vec1.head(n)\endcode\code vec1.head()\endcodethe first \c n coeffs \code vec1.tail(n)\endcode\code vec1.tail()\endcodethe last \c n coeffs \code vec1.segment(pos,n)\endcode\code vec1.segment(pos)\endcode - the \c size coeffs in \n the range [\c pos : \c pos + \c n [ + the \c n coeffs in \n the range [\c pos : \c pos + \c n [ Read-write access to sub-matrices: -- cgit v1.2.3