From f41d96deb9b64e74cd2d8c48a698f4443ce9bbab Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Mon, 24 Dec 2012 13:33:22 +0100 Subject: Fix several documentation issues --- doc/QuickReference.dox | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/QuickReference.dox') diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index 31b8030f4..f91b96e52 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -31,7 +31,7 @@ The Eigen library is divided in a Core module and several additional modules. Ea \link SVD_Module SVD \endlink\code#include \endcodeSVD decomposition with least-squares solver (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) +\link Sparse_modules 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) @@ -89,8 +89,8 @@ MatrixWrapper a1m(a1); \endcode In the rest of this document we will use the following symbols to emphasize the features which are specifics to a given kind of object: -\li \matrixworld linear algebra matrix and vector only -\li \arrayworld array objects only +\li \matrixworld linear algebra matrix and vector only +\li \arrayworld array objects only \subsection QuickRef_Basics Basic matrix manipulation @@ -458,7 +458,7 @@ mat = 2 7 8 \endcode -Special versions of \link DenseBase::minCoeff(Index*,Index*) minCoeff \endlink and \link DenseBase::maxCoeff(Index*,Index*) maxCoeff \endlink: +Special versions of \link DenseBase::minCoeff(IndexType*,IndexType*) const minCoeff \endlink and \link DenseBase::maxCoeff(IndexType*,IndexType*) const maxCoeff \endlink: \code int i, j; s = vector.minCoeff(&i); // s == vector[i] -- cgit v1.2.3