From 8bfa354ee3267691a7aec6fe576847296e074c90 Mon Sep 17 00:00:00 2001 From: Jitse Niesen Date: Tue, 8 Dec 2009 15:12:27 +0000 Subject: 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 --- doc/Overview.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/Overview.dox') 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. 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. Most of the other classes are just return types for MatrixBase methods. -- cgit v1.2.3