diff options
author | Gael Guennebaud <g.gael@free.fr> | 2012-12-24 13:33:22 +0100 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2012-12-24 13:33:22 +0100 |
commit | f41d96deb9b64e74cd2d8c48a698f4443ce9bbab (patch) | |
tree | bb36884185b0bfa99c16338403fc5736cbd7eba9 /doc/QuickReference.dox | |
parent | f450303321c4d37d908d5d9e6fcf480f27bf53e3 (diff) |
Fix several documentation issues
Diffstat (limited to 'doc/QuickReference.dox')
-rw-r--r-- | doc/QuickReference.dox | 8 |
1 files changed, 4 insertions, 4 deletions
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 <tr><td>\link SVD_Module SVD \endlink</td><td>\code#include <Eigen/SVD>\endcode</td><td>SVD decomposition with least-squares solver (JacobiSVD)</td></tr> <tr class="alt"><td>\link QR_Module QR \endlink</td><td>\code#include <Eigen/QR>\endcode</td><td>QR decomposition with solver (HouseholderQR, ColPivHouseholderQR, FullPivHouseholderQR)</td></tr> <tr><td>\link Eigenvalues_Module Eigenvalues \endlink</td><td>\code#include <Eigen/Eigenvalues>\endcode</td><td>Eigenvalue, eigenvector decompositions (EigenSolver, SelfAdjointEigenSolver, ComplexEigenSolver)</td></tr> -<tr class="alt"><td>\link Sparse_Module Sparse \endlink</td><td>\code#include <Eigen/Sparse>\endcode</td><td>%Sparse matrix storage and related basic linear algebra (SparseMatrix, DynamicSparseMatrix, SparseVector)</td></tr> +<tr class="alt"><td>\link Sparse_modules Sparse \endlink</td><td>\code#include <Eigen/Sparse>\endcode</td><td>%Sparse matrix storage and related basic linear algebra (SparseMatrix, DynamicSparseMatrix, SparseVector)</td></tr> <tr><td></td><td>\code#include <Eigen/Dense>\endcode</td><td>Includes Core, Geometry, LU, Cholesky, SVD, QR, and Eigenvalues header files</td></tr> <tr class="alt"><td></td><td>\code#include <Eigen/Eigen>\endcode</td><td>Includes %Dense and %Sparse header files (the whole Eigen library)</td></tr> </table> @@ -89,8 +89,8 @@ MatrixWrapper<Array44f> 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 <a name="matrixonly"><a/>\matrixworld linear algebra matrix and vector only -\li <a name="arrayonly"><a/>\arrayworld array objects only +\li <a name="matrixonly"></a>\matrixworld linear algebra matrix and vector only +\li <a name="arrayonly"></a>\arrayworld array objects only \subsection QuickRef_Basics Basic matrix manipulation @@ -458,7 +458,7 @@ mat = 2 7 8 \endcode</td></tr> </table> -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] |