diff options
author | Jim Guggemos <jimg@google.com> | 2012-12-04 16:46:41 -0700 |
---|---|---|
committer | Jim Guggemos <jimg@google.com> | 2012-12-04 17:08:38 -0700 |
commit | b015e75e8c7ba1ab4ddb91e9372a57e76f3fd159 (patch) | |
tree | 54d1c7d66098154c1d7c5bd414394ef4cf255810 /doc/Overview.dox | |
parent | 63f67d748682b46d58be31235a0a2d64d81b998c (diff) | |
parent | c981c48f5bc9aefeffc0bcb0cc3934c2fae179dd (diff) | |
download | eigen-idea133.tar.gz |
Merge 'goog/jb-mr1.1-dev' into platform/external/eigen.android-sdk-4.4.2_r1.0.1android-sdk-4.4.2_r1android-cts-4.4_r1android-4.4w_r1android-4.4_r0.7android-4.4.4_r2.0.1android-4.4.4_r2android-4.4.4_r1.0.1android-4.4.4_r1android-4.4.3_r1.1.0.1android-4.4.3_r1.1android-4.4.3_r1.0.1android-4.4.3_r1android-4.4.2_r2.0.1android-4.4.2_r2android-4.4.2_r1.0.1android-4.4.2_r1android-4.4.1_r1.0.1android-4.4.1_r1android-4.3_r3.1android-4.3_r3android-4.3.1_r1tools_r22.2tools_r22kitkat-wearkitkat-mr2.2-releasekitkat-mr2.1-releasekitkat-mr2-releasekitkat-mr1.1-releasekitkat-mr1-releasekitkat-devkitkat-cts-devjb-mr2.0.0-releasejb-mr2-devjb-mr1.1-dev-plus-aospjb-mr1-dev-plus-aospidea133-weekly-releaseidea133
Change-Id: Ic9004531328145ea36ba513bb96a23595427f6a4
Diffstat (limited to 'doc/Overview.dox')
-rw-r--r-- | doc/Overview.dox | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/Overview.dox b/doc/Overview.dox new file mode 100644 index 000000000..2657c85bc --- /dev/null +++ b/doc/Overview.dox @@ -0,0 +1,60 @@ +namespace Eigen { + +o /** \mainpage Eigen + +<div class="eimainmenu"> + \ref GettingStarted "Getting started" + | \ref TutorialMatrixClass "Tutorial" + | \ref QuickRefPage "Short reference" +</div> + +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 + + + +Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>. + +*/ + +} |