aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Overview.dox
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2009-12-08 15:12:27 +0000
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2009-12-08 15:12:27 +0000
commit8bfa354ee3267691a7aec6fe576847296e074c90 (patch)
treeaddb0b77e7546ca1da4984f15b3d6bf52d82f1ce /doc/Overview.dox
parenta682a0eeb1246725a0f6bbbe02eeedf81d26b22b (diff)
Documentation clean up.
* remove non-existant reference to CwiseAll * define \householder_module (used in HouseholderSequence.h) * update I01_TopicLazyEvaluation.dox - Product is now called GeneralProduct * remove reference to list of examples which was deleted ages ago * rename PartialLU_solve.cpp snippet to PartialPivLU_solve.cpp
Diffstat (limited to 'doc/Overview.dox')
-rw-r--r--doc/Overview.dox2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/Overview.dox b/doc/Overview.dox
index db0d9587a..78bf5f9dd 100644
--- a/doc/Overview.dox
+++ b/doc/Overview.dox
@@ -15,7 +15,7 @@ For a first contact with Eigen, the best place is to have a look at the \ref Tut
Most of the API is available as methods in MatrixBase, so this is a good starting point for browsing. Also have a look at Matrix, as a few methods and the matrix constructors are there. Other notable classes for the Eigen API are Cwise, which contains the methods for doing certain coefficient-wise operations, and Part.
-In fact, except for advanced use, the only class that you'll have to explicitly name in your program, i.e. of which you'll explicitly contruct objects, is Matrix. For instance, vectors are handled as a special case of Matrix with one column. Typedefs are provided, e.g. Vector2f is a typedef for Matrix<float, 2, 1>. Finally, you might also have look at the \ref ExampleList "the list of selected examples".
+In fact, except for advanced use, the only class that you'll have to explicitly name in your program, i.e. of which you'll explicitly contruct objects, is Matrix. For instance, vectors are handled as a special case of Matrix with one column. Typedefs are provided, e.g. Vector2f is a typedef for Matrix<float, 2, 1>.
Most of the other classes are just return types for MatrixBase methods.