eigen/doc/Overview.dox
2010-07-04 10:37:32 +02:00

54 lines
1.9 KiB
Plaintext

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.
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 features, 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.
\b Table \b of \b contents
- \ref Eigen2ToEigen3
- \ref GettingStarted
- \b Tutorial
- \ref TutorialMatrixClass
- \ref TutorialMatrixArithmetic
- \ref TutorialArrayClass
- \ref TutorialBlockOperations
- \ref TutorialAdvancedInitialization
- Comming soon: "Reductions, visitors, and broadcasting"
- \ref TutorialLinearAlgebra
- \ref TutorialGeometry
- \ref TutorialSparseMatrix
- \ref QuickRefPage
- <b>Advanced topics</b>
- \ref TopicLazyEvaluation
- \ref TopicLinearAlgebraDecompositions
- \ref TopicCustomizingEigen
- \ref TopicInsideEigenExample
- \ref TopicHiPerformance
- <b>Topics on getting high performances</b>
- \ref TopicWritingEfficientProductExpression
- <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>.
*/
}