diff options
author | Carlos Hernandez <chernand@google.com> | 2014-08-05 17:53:32 -0700 |
---|---|---|
committer | Carlos Hernandez <chernand@google.com> | 2014-08-05 17:54:05 -0700 |
commit | 7faaa9f3f0df9d23790277834d426c3d992ac3ba (patch) | |
tree | b788ae3b96daf9f5a79d8ec434e1e9edd56b3a72 /doc/Overview.dox | |
parent | 810535bb0c575a003b32076e5352ab8fd3f23a1c (diff) | |
download | eigen-7faaa9f3f0df9d23790277834d426c3d992ac3ba.tar.gz |
Update Eigen to the latest stable release, 3.2.2android-wear-5.1.1_r1android-wear-5.1.0_r1android-wear-5.0.0_r1android-l-preview_r2android-cts-5.1_r9android-cts-5.1_r8android-cts-5.1_r7android-cts-5.1_r6android-cts-5.1_r5android-cts-5.1_r4android-cts-5.1_r3android-cts-5.1_r28android-cts-5.1_r27android-cts-5.1_r26android-cts-5.1_r25android-cts-5.1_r24android-cts-5.1_r23android-cts-5.1_r22android-cts-5.1_r21android-cts-5.1_r20android-cts-5.1_r2android-cts-5.1_r19android-cts-5.1_r18android-cts-5.1_r17android-cts-5.1_r16android-cts-5.1_r15android-cts-5.1_r14android-cts-5.1_r13android-cts-5.1_r10android-cts-5.1_r1android-cts-5.0_r9android-cts-5.0_r8android-cts-5.0_r7android-cts-5.0_r6android-cts-5.0_r5android-cts-5.0_r4android-cts-5.0_r3android-5.1.1_r9android-5.1.1_r8android-5.1.1_r7android-5.1.1_r6android-5.1.1_r5android-5.1.1_r4android-5.1.1_r38android-5.1.1_r37android-5.1.1_r36android-5.1.1_r35android-5.1.1_r34android-5.1.1_r33android-5.1.1_r30android-5.1.1_r3android-5.1.1_r29android-5.1.1_r28android-5.1.1_r26android-5.1.1_r25android-5.1.1_r24android-5.1.1_r23android-5.1.1_r22android-5.1.1_r20android-5.1.1_r2android-5.1.1_r19android-5.1.1_r18android-5.1.1_r17android-5.1.1_r16android-5.1.1_r15android-5.1.1_r14android-5.1.1_r13android-5.1.1_r12android-5.1.1_r10android-5.1.1_r1android-5.1.0_r5android-5.1.0_r4android-5.1.0_r3android-5.1.0_r1android-5.0.2_r3android-5.0.2_r1android-5.0.1_r1android-5.0.0_r7android-5.0.0_r6android-5.0.0_r5.1android-5.0.0_r5android-5.0.0_r4android-5.0.0_r3android-5.0.0_r2android-5.0.0_r1lollipop-wear-releaselollipop-releaselollipop-mr1-wfc-releaselollipop-mr1-releaselollipop-mr1-fi-releaselollipop-mr1-devlollipop-mr1-cts-releaselollipop-devlollipop-cts-releasel-preview
./Eigen/src/Core/util/NonMPL2.h is left untouched, so that
usage of non MPL2 code is disabled.
Change-Id: I86fc9257b3c30d0ca15b268d4ef07bf038bba7ca
Diffstat (limited to 'doc/Overview.dox')
-rw-r--r-- | doc/Overview.dox | 66 |
1 files changed, 17 insertions, 49 deletions
diff --git a/doc/Overview.dox b/doc/Overview.dox index 2657c85bc..9ab96233a 100644 --- a/doc/Overview.dox +++ b/doc/Overview.dox @@ -1,59 +1,27 @@ namespace Eigen { -o /** \mainpage Eigen - -<div class="eimainmenu"> - \ref GettingStarted "Getting started" - | \ref TutorialMatrixClass "Tutorial" - | \ref QuickRefPage "Short reference" -</div> +/** \mainpage notitle This is the API documentation for Eigen3. You can <a href="eigen-doc.tgz">download</a> 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 <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. - -\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 - - <b>Advanced topics</b> - - \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 - - <b>Topics related to alignment issues</b> - - \ref TopicUnalignedArrayAssert - - \ref TopicFixedSizeVectorizable - - \ref TopicStlContainers - - \ref TopicStructHavingEigenMembers - - \ref TopicPassingByValue - - \ref TopicWrongStackAlignment +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 <a href="AsciiQuickReference.txt">short ASCII reference</a> 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. + +Under 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, useful to quickly get to the documentation of a given class or function. -Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>. +Want more? Checkout the <a href="unsupported/index.html">\em unsupported \em modules </a> documentation. */ |