From 86983fa1ffb2a06635dc6a78b90e3e76637b7b55 Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Sat, 5 Jan 2013 21:25:41 +0100 Subject: Update the overview page to reflect the new organisation --- doc/Overview.dox | 66 ++++++++++++++++---------------------------------------- 1 file changed, 18 insertions(+), 48 deletions(-) (limited to 'doc/Overview.dox') diff --git a/doc/Overview.dox b/doc/Overview.dox index 0b08f851a..f7d1ac789 100644 --- a/doc/Overview.dox +++ b/doc/Overview.dox @@ -2,56 +2,26 @@ namespace Eigen { /** \mainpage notitle -
- \ref GettingStarted "Getting started" - | \ref TutorialMatrixClass "Tutorial" - | \ref QuickRefPage "Short reference" -
- This is the API documentation for Eigen3. You can download it as a tgz archive for offline reading. -Eigen2 users: here is a \ref Eigen2ToEigen3 guide to help porting your application. - -For a first contact with Eigen, the best place is to have a look at the \ref GettingStarted "tutorial". The \ref QuickRefPage "short reference" page gives you a quite complete description of the API in a very condensed format that is specially useful to recall the syntax of a particular feature, or to have a quick look at the API. For Matlab users, there is also a ASCII quick reference with Matlab translations. The \e Modules and \e Classes tabs at the top of this page give you access to the API documentation of individual classes and functions. - -\b Table \b of \b contents - - \ref Eigen2ToEigen3 - - \ref GettingStarted - - \b Tutorial - - \ref TutorialMatrixClass - - \ref TutorialMatrixArithmetic - - \ref TutorialArrayClass - - \ref TutorialBlockOperations - - \ref TutorialAdvancedInitialization - - \ref TutorialLinearAlgebra - - \ref TutorialReductionsVisitorsBroadcasting - - \ref TutorialGeometry - - \ref TutorialSparse - - \ref TutorialMapClass - - \ref QuickRefPage - - \subpage UserManual_Generalities - - \ref TopicAliasing - - \ref TopicLazyEvaluation - - \ref TopicLinearAlgebraDecompositions - - \ref TopicCustomizingEigen - - \ref TopicMultiThreading - - \ref TopicPreprocessorDirectives - - \ref TopicStorageOrders - - \ref TopicInsideEigenExample - - \ref TopicWritingEfficientProductExpression - - \ref TopicClassHierarchy - - \ref TopicFunctionTakingEigenTypes - - \ref TopicTemplateKeyword - - \ref TopicUsingIntelMKL - - Topics related to alignment issues - - \ref TopicUnalignedArrayAssert - - \ref TopicFixedSizeVectorizable - - \ref TopicStlContainers - - \ref TopicStructHavingEigenMembers - - \ref TopicPassingByValue - - \ref TopicWrongStackAlignment - -Want more? Checkout the \ref Unsupported_modules "unsupported modules" documentation. +You're already an Eigen2 user? Here is a \link Eigen2ToEigen3 Eigen2 to Eigen3 guide \endlink to help porting your application. + +For a first contact with Eigen, the best place is to have a look at the \link GettingStarted getting started \endlink page that show you how to write and compile your first program with Eigen. + +Then, the \b quick \b reference \b pages give you a quite complete description of the API in a very condensed format that is specially useful to recall the syntax of a particular feature, or to have a quick look at the API. They currently cover the two following feature sets, and more will come in the future: + - \link QuickRefPage [QuickRef] Dense matrix and array manipulations \endlink + - \link SparseQuickRefPage [QuickRef] Sparse linear algebra \endlink + +You're a MatLab user? There is also a short ASCII reference with Matlab translations. + +The \b main \b documentation is organized into \em chapters covering different domains of features. +They are themselves composed of \em user \em manual pages describing the different features in a comprehensive way, and \em reference pages that gives you access to the API documentation through the related Eigen's \em modules and \em classes. + +Ynder the \subpage UserManual_Generalities section, you will find documentation on more general topics such as preprocessor directives, controlling assertions, multi-threading, MKL support, some Eigen's internal insights, and much more... + +Finally, do not miss the search-engine that is convenient to quickly found the documentation of a given class or function. + +Want more? Checkout the \em unsupported \em modules documentation. */ -- cgit v1.2.3