aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/QuickStartGuide.dox
diff options
context:
space:
mode:
authorGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2008-12-06 22:21:29 +0000
committerGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2008-12-06 22:21:29 +0000
commit2b20da624a4967334fbf18209a2bbec7b5605d49 (patch)
treea01897a456d705e1c6c12c5ed757c7e7312513b2 /doc/QuickStartGuide.dox
parentbb33ec4ef31e4a1561eaecfb23b11ec88e061cc2 (diff)
* improvements in the tutorial: triangular matrices, linear algebra
* minor fixes in Part and StaticAssert * EulerAngles: remove the FIXME as I think the current version is fine
Diffstat (limited to 'doc/QuickStartGuide.dox')
-rw-r--r--doc/QuickStartGuide.dox32
1 files changed, 31 insertions, 1 deletions
diff --git a/doc/QuickStartGuide.dox b/doc/QuickStartGuide.dox
index d9f7d4b61..aa40606ed 100644
--- a/doc/QuickStartGuide.dox
+++ b/doc/QuickStartGuide.dox
@@ -507,7 +507,37 @@ vec1.normalize();\endcode
<a href="#" class="top">top</a>\section TutorialCoreTriangularMatrix Dealing with triangular matrices
-todo
+Read/write access to special parts of a matrix can be achieved. See \link MatrixBase::part() const this \endlink for read access and \link MatrixBase::part() this \endlink for write access..
+
+<table class="tutorial_code">
+<tr><td>
+Extract triangular matrices \n from a given matrix m:
+</td><td>\code
+m.part<Eigen::Upper>()
+m.part<Eigen::StrictlyUpper>()
+m.part<Eigen::UnitUpper>()
+m.part<Eigen::Lower>()
+m.part<Eigen::StrictlyLower>()
+m.part<Eigen::UnitLower>()\endcode
+</td></tr>
+<tr><td>
+Write to triangular parts \n of a matrix m:
+</td><td>\code
+m1.part<Eigen::Upper>() = m2;
+m1.part<Eigen::StrictlyUpper>() = m2;
+m1.part<Eigen::Lower>() = m2;
+m1.part<Eigen::StrictlyLower>() = m2;\endcode
+</td></tr>
+<tr><td>
+Special: take advantage of symmetry \n (selfadjointness) when copying \n an expression into a matrix
+</td><td>\code
+m.part<Eigen::SelfAdjoint>() = someSelfadjointMatrix;
+m1.part<Eigen::SelfAdjoint>() = m2 + m2.adjoint(); // m2 + m2.adjoint() is selfadjoint \endcode
+</td></tr>
+
+
+</table>
+
<a href="#" class="top">top</a>\section TutorialCoreSpecialTopics Special Topics