1 namespace Eigen { 2 3 o /** \mainpage Eigen 4 5 <div class="eimainmenu"> 6 \ref GettingStarted "Getting started" 7 | \ref TutorialMatrixClass "Tutorial" 8 | \ref QuickRefPage "Short reference" 9 </div> 10 11 This is the API documentation for Eigen3. You can <a href="eigen-doc.tgz">download</a> it as a tgz archive for offline reading. 12 13 Eigen2 users: here is a \ref Eigen2ToEigen3 guide to help porting your application. 14 15 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 <a href="AsciiQuickReference.txt">ASCII quick reference</a> 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. 16 17 \b Table \b of \b contents 18 - \ref Eigen2ToEigen3 19 - \ref GettingStarted 20 - \b Tutorial 21 - \ref TutorialMatrixClass 22 - \ref TutorialMatrixArithmetic 23 - \ref TutorialArrayClass 24 - \ref TutorialBlockOperations 25 - \ref TutorialAdvancedInitialization 26 - \ref TutorialLinearAlgebra 27 - \ref TutorialReductionsVisitorsBroadcasting 28 - \ref TutorialGeometry 29 - \ref TutorialSparse 30 - \ref TutorialMapClass 31 - \ref QuickRefPage 32 - <b>Advanced topics</b> 33 - \ref TopicAliasing 34 - \ref TopicLazyEvaluation 35 - \ref TopicLinearAlgebraDecompositions 36 - \ref TopicCustomizingEigen 37 - \ref TopicMultiThreading 38 - \ref TopicPreprocessorDirectives 39 - \ref TopicStorageOrders 40 - \ref TopicInsideEigenExample 41 - \ref TopicWritingEfficientProductExpression 42 - \ref TopicClassHierarchy 43 - \ref TopicFunctionTakingEigenTypes 44 - \ref TopicTemplateKeyword 45 - \ref TopicUsingIntelMKL 46 - <b>Topics related to alignment issues</b> 47 - \ref TopicUnalignedArrayAssert 48 - \ref TopicFixedSizeVectorizable 49 - \ref TopicStlContainers 50 - \ref TopicStructHavingEigenMembers 51 - \ref TopicPassingByValue 52 - \ref TopicWrongStackAlignment 53 54 55 56 Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>. 57 58 */ 59 60 } 61
