diff --git a/doc/C01_TutorialMatrixClass.dox b/doc/C01_TutorialMatrixClass.dox index 41cfb777c..057341422 100644 --- a/doc/C01_TutorialMatrixClass.dox +++ b/doc/C01_TutorialMatrixClass.dox @@ -2,12 +2,6 @@ namespace Eigen { /** \eigenManualPage TutorialMatrixClass The Matrix class -\li \b Previous: \ref GettingStarted -\li \b Next: \ref TutorialMatrixArithmetic - -We assume that you have already read the quick \link GettingStarted "getting started" \endlink tutorial. -This page is the first one in a much longer multi-page tutorial. - \eigenAutoToc In Eigen, all matrices and vectors are objects of the Matrix template class. @@ -264,7 +258,6 @@ Where: defined for these five types doesn't mean that they are the only supported scalar types. For example, all standard integer types are supported, see \ref TopicScalarTypes "Scalar types". -\li \b Next: \ref TutorialMatrixArithmetic */ diff --git a/doc/C02_TutorialMatrixArithmetic.dox b/doc/C02_TutorialMatrixArithmetic.dox index 2969d54eb..5fc569a30 100644 --- a/doc/C02_TutorialMatrixArithmetic.dox +++ b/doc/C02_TutorialMatrixArithmetic.dox @@ -2,10 +2,7 @@ namespace Eigen { /** \eigenManualPage TutorialMatrixArithmetic Matrix and vector arithmetic -\li \b Previous: \ref TutorialMatrixClass -\li \b Next: \ref TutorialArrayClass - -This tutorial aims to provide an overview and some details on how to perform arithmetic +This page aims to provide an overview and some details on how to perform arithmetic between matrices, vectors and scalars with Eigen. \eigenAutoToc @@ -212,8 +209,6 @@ Eigen then uses runtime assertions. This means that the program will abort with For more details on this topic, see \ref TopicAssertions "this page". -\li \b Next: \ref TutorialArrayClass - */ } diff --git a/doc/C03_TutorialArrayClass.dox b/doc/C03_TutorialArrayClass.dox index 6531ee232..6432684aa 100644 --- a/doc/C03_TutorialArrayClass.dox +++ b/doc/C03_TutorialArrayClass.dox @@ -2,10 +2,7 @@ namespace Eigen { /** \eigenManualPage TutorialArrayClass The Array class and coefficient-wise operations -\li \b Previous: \ref TutorialMatrixArithmetic -\li \b Next: \ref TutorialBlockOperations - -This tutorial aims to provide an overview and explanations on how to use +This page aims to provide an overview and explanations on how to use Eigen's Array class. \eigenAutoToc @@ -190,8 +187,6 @@ expression (m.array() * n.array()).matrix() * m computes the coefficien \verbinclude Tutorial_ArrayClass_interop.out -\li \b Next: \ref TutorialBlockOperations - */ } diff --git a/doc/C04_TutorialBlockOperations.dox b/doc/C04_TutorialBlockOperations.dox index 64454a65e..a2d8c97cc 100644 --- a/doc/C04_TutorialBlockOperations.dox +++ b/doc/C04_TutorialBlockOperations.dox @@ -2,10 +2,7 @@ namespace Eigen { /** \eigenManualPage TutorialBlockOperations Block operations -\li \b Previous: \ref TutorialArrayClass -\li \b Next: \ref TutorialAdvancedInitialization - -This tutorial page explains the essentials of block operations. +This page explains the essentials of block operations. A block is a rectangular part of a matrix or array. Blocks expressions can be used both as rvalues and as lvalues. As usual with Eigen expressions, this abstraction has zero runtime cost provided that you let your compiler optimize. @@ -226,8 +223,6 @@ An example is presented below: \verbinclude Tutorial_BlockOperations_vector.out -\li \b Next: \ref TutorialAdvancedInitialization - */ } diff --git a/doc/C05_TutorialAdvancedInitialization.dox b/doc/C05_TutorialAdvancedInitialization.dox index acbf9b8cb..50374d0d0 100644 --- a/doc/C05_TutorialAdvancedInitialization.dox +++ b/doc/C05_TutorialAdvancedInitialization.dox @@ -2,9 +2,6 @@ namespace Eigen { /** \eigenManualPage TutorialAdvancedInitialization Advanced initialization -\li \b Previous: \ref TutorialBlockOperations -\li \b Next: \ref TutorialLinearAlgebra - This page discusses several advanced methods for initializing matrices. It gives more details on the comma-initializer, which was introduced before. It also explains how to get special matrices such as the identity matrix and the zero matrix. @@ -160,8 +157,6 @@ The \link CommaInitializer::finished() finished() \endlink method is necessary h object once the comma initialization of our temporary submatrix is done. -\li \b Next: \ref TutorialLinearAlgebra - */ } diff --git a/doc/C06_TutorialLinearAlgebra.dox b/doc/C06_TutorialLinearAlgebra.dox index c6235f268..b09f3543e 100644 --- a/doc/C06_TutorialLinearAlgebra.dox +++ b/doc/C06_TutorialLinearAlgebra.dox @@ -2,12 +2,9 @@ namespace Eigen { /** \eigenManualPage TutorialLinearAlgebra Linear algebra and decompositions -\li \b Previous: \ref TutorialAdvancedInitialization -\li \b Next: \ref TutorialReductionsVisitorsBroadcasting - -This tutorial explains how to solve linear systems, compute various decompositions such as LU, -QR, %SVD, eigendecompositions... for more advanced topics, don't miss our special page on -\ref TopicLinearAlgebraDecompositions "this topic". +This page explains how to solve linear systems, compute various decompositions such as LU, +QR, %SVD, eigendecompositions... After reading this page, don't miss our +\link TopicLinearAlgebraDecompositions catalogue \endlink of dense matrix decompositions. \eigenAutoToc @@ -253,8 +250,6 @@ decomposition after you've changed the threshold. -\li \b Next: \ref TutorialReductionsVisitorsBroadcasting - */ } diff --git a/doc/C07_TutorialReductionsVisitorsBroadcasting.dox b/doc/C07_TutorialReductionsVisitorsBroadcasting.dox index 222965175..992cf6f34 100644 --- a/doc/C07_TutorialReductionsVisitorsBroadcasting.dox +++ b/doc/C07_TutorialReductionsVisitorsBroadcasting.dox @@ -2,10 +2,7 @@ namespace Eigen { /** \eigenManualPage TutorialReductionsVisitorsBroadcasting Reductions, visitors and broadcasting -\li \b Previous: \ref TutorialLinearAlgebra -\li \b Next: \ref TutorialGeometry - -This tutorial explains Eigen's reductions, visitors and broadcasting and how they are used with +This page explains Eigen's reductions, visitors and broadcasting and how they are used with \link MatrixBase matrices \endlink and \link ArrayBase arrays \endlink. \eigenAutoToc @@ -255,8 +252,6 @@ this operation is a row-vector where each coefficient is the squared Euclidean d - Finally, minCoeff(&index) is used to obtain the index of the column in m that is closest to v in terms of Euclidean distance. -\li \b Next: \ref TutorialGeometry - */ } diff --git a/doc/C08_TutorialGeometry.dox b/doc/C08_TutorialGeometry.dox index 90038cd2a..81aeec978 100644 --- a/doc/C08_TutorialGeometry.dox +++ b/doc/C08_TutorialGeometry.dox @@ -1,11 +1,8 @@ namespace Eigen { -/** \eigenManualPage TutorialGeometry Geometry +/** \eigenManualPage TutorialGeometry Space transformations -\li \b Previous: \ref TutorialReductionsVisitorsBroadcasting -\li \b Next: \ref TutorialSparse - -In this tutorial, we will briefly introduce the many possibilities offered by the \ref Geometry_Module "geometry module", namely 2D and 3D rotations and projective or affine transformations. +In this page, we will introduce the many possibilities offered by the \ref Geometry_Module "geometry module" to deal with 2D and 3D rotations and projective or affine transformations. \eigenAutoToc @@ -239,8 +236,6 @@ m = AngleAxisf(angle1, Vector3f::UnitZ()) \endcode -\li \b Next: \ref TutorialSparse - */ } diff --git a/doc/C09_TutorialSparse.dox b/doc/C09_TutorialSparse.dox index fab3432a2..9f06005fa 100644 --- a/doc/C09_TutorialSparse.dox +++ b/doc/C09_TutorialSparse.dox @@ -2,13 +2,8 @@ namespace Eigen { /** \eigenManualPage TutorialSparse Sparse matrix manipulations -\li \b Previous: \ref TutorialGeometry -\li \b Next: \ref TutorialMapClass - \eigeneigenAutoToc -