aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2013-01-06 23:48:59 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2013-01-06 23:48:59 +0100
commit091a49cad5d3aed47de9cb78c821c5f11b85e5f8 (patch)
tree8c80c8ec86dcec8296cabe5d11d1182be0cba6e5 /doc
parentc71c06b71f3589313f0d687058e5a77576c790a6 (diff)
Clean the manual page titles, links and intro.
Diffstat (limited to 'doc')
-rw-r--r--doc/C01_TutorialMatrixClass.dox7
-rw-r--r--doc/C02_TutorialMatrixArithmetic.dox7
-rw-r--r--doc/C03_TutorialArrayClass.dox7
-rw-r--r--doc/C04_TutorialBlockOperations.dox7
-rw-r--r--doc/C05_TutorialAdvancedInitialization.dox5
-rw-r--r--doc/C06_TutorialLinearAlgebra.dox11
-rw-r--r--doc/C07_TutorialReductionsVisitorsBroadcasting.dox7
-rw-r--r--doc/C08_TutorialGeometry.dox9
-rw-r--r--doc/C09_TutorialSparse.dox7
-rw-r--r--doc/C10_TutorialMapClass.dox12
-rw-r--r--doc/TopicLinearAlgebraDecompositions.dox4
-rw-r--r--doc/eigendoxy.css6
-rw-r--r--doc/eigendoxy_layout.xml.in1
13 files changed, 21 insertions, 69 deletions
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 <tt>(m.array() * n.array()).matrix() * m</tt> computes the coefficien
\verbinclude Tutorial_ArrayClass_interop.out
</td></tr></table>
-\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
</td></tr></table>
-\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.
</tr>
</table>
-\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, <tt>minCoeff(&index)</tt> is used to obtain the index of the column in <tt>m</tt> that is closest to <tt>v</tt> 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</td></tr>
</table>
-\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
-<hr>
-
Manipulating and solving sparse problems involves various modules which are summarized below:
<table class="manual">
@@ -436,8 +431,6 @@ sm2.selfadjointView<Lower>() = A.selfadjointView<Lower>().twistedBy(P); //
sm1.middleCols(j, nb); // for column major matrices only, get a range of nb columns
\endcode
-\li \b Next: \ref TutorialMapClass
-
*/
}
diff --git a/doc/C10_TutorialMapClass.dox b/doc/C10_TutorialMapClass.dox
index 0d9dc602f..a5c20f1bf 100644
--- a/doc/C10_TutorialMapClass.dox
+++ b/doc/C10_TutorialMapClass.dox
@@ -1,13 +1,9 @@
namespace Eigen {
-/** \eigenManualPage TutorialMapClass Interfacing with C/C++ arrays and external libraries: the %Map class
+/** \eigenManualPage TutorialMapClass Interfacing with raw buffers: the Map class
-\ingroup Tutorial
-
-\li \b Previous: \ref TutorialSparse
-\li \b Next:
-
-This tutorial page explains how to work with "raw" C++ arrays. This can be useful in a variety of contexts, particularly when "importing" vectors and matrices from other libraries into Eigen.
+This page explains how to work with "raw" C/C++ arrays.
+This can be useful in a variety of contexts, particularly when "importing" vectors and matrices from other libraries into Eigen.
\eigenAutoToc
@@ -85,8 +81,6 @@ for (int i = 0; i < n_matrices; i++)
}
\endcode
-\li \b Next:
-
*/
}
diff --git a/doc/TopicLinearAlgebraDecompositions.dox b/doc/TopicLinearAlgebraDecompositions.dox
index a401bb999..8649cc27b 100644
--- a/doc/TopicLinearAlgebraDecompositions.dox
+++ b/doc/TopicLinearAlgebraDecompositions.dox
@@ -1,7 +1,9 @@
namespace Eigen {
-/** \eigenManualPage TopicLinearAlgebraDecompositions Linear algebra and decompositions (catalogue)
+/** \eigenManualPage TopicLinearAlgebraDecompositions Catalogue of dense decompositions
+This page presents a catalogue of the dense matrix decompositions offered by Eigen.
+For an introduction on linear solvers and decompositions, check this \link TutorialLinearAlgebra page \endlink.
\section TopicLinAlgBigTable Catalogue of decompositions offered by Eigen
diff --git a/doc/eigendoxy.css b/doc/eigendoxy.css
index 9efb30308..60243d870 100644
--- a/doc/eigendoxy.css
+++ b/doc/eigendoxy.css
@@ -15,13 +15,17 @@ div.contents hr {
/**** ****/
-/* limits the width of paragraphs */
p, dl.warning, dl.attention, dl.note
{
max-width:60em;
text-align:justify;
}
+li {
+ max-width:55em;
+ text-align:justify;
+}
+
img {
border: 0;
}
diff --git a/doc/eigendoxy_layout.xml.in b/doc/eigendoxy_layout.xml.in
index e2fd9b850..c14b621e5 100644
--- a/doc/eigendoxy_layout.xml.in
+++ b/doc/eigendoxy_layout.xml.in
@@ -7,6 +7,7 @@
<tab type="modules" visible="yes" title="Chapters" intro=""/>
<tab type="mainpage" visible="yes" title=""/>
<tab type="classlist" visible="yes" title="" intro=""/>
+<!-- <tab type="classmembers" visible="yes" title="" intro=""/> -->
</navindex>
<!-- Layout definition for a class page -->