2008-06-03 02:27:37 +08:00
namespace Eigen {
2008-05-29 11:12:30 +08:00
o /** \mainpage Eigen
2007-12-21 15:30:15 +08:00
2010-06-27 04:42:14 +08:00
<div class="eimainmenu">
\ref GettingStarted "Getting started"
| \ref TutorialMatrixClass "Tutorial"
| \ref QuickRefPage "Short reference"
2008-08-27 03:12:23 +08:00
</div>
2010-01-06 20:56:04 +08:00
This is the API documentation for Eigen3.
2010-04-23 02:11:18 +08:00
Eigen2 users: here is a \ref Eigen2ToEigen3 guide to help porting your application.
2007-12-21 15:30:15 +08:00
2010-07-05 17:59:29 +08:00
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.
2010-06-27 04:42:14 +08:00
\b Table \b of \b contents
2010-07-04 16:14:47 +08:00
- \ref Eigen2ToEigen3
2010-06-27 04:42:14 +08:00
- \ref GettingStarted
- \b Tutorial
- \ref TutorialMatrixClass
- \ref TutorialMatrixArithmetic
- \ref TutorialArrayClass
2010-06-29 21:23:49 +08:00
- \ref TutorialBlockOperations
2010-07-04 16:14:47 +08:00
- \ref TutorialAdvancedInitialization
- \ref TutorialLinearAlgebra
2010-07-09 00:45:25 +08:00
- \ref TutorialReductionsVisitorsBroadcasting
2010-07-04 16:14:47 +08:00
- \ref TutorialGeometry
2010-07-06 12:50:16 +08:00
- \ref TutorialSparse
2010-06-27 04:42:14 +08:00
- \ref QuickRefPage
2010-07-04 16:37:32 +08:00
- <b>Advanced topics</b>
2010-07-04 16:14:47 +08:00
- \ref TopicLazyEvaluation
- \ref TopicLinearAlgebraDecompositions
- \ref TopicCustomizingEigen
- \ref TopicInsideEigenExample
2010-07-04 16:37:32 +08:00
- \ref TopicWritingEfficientProductExpression
2010-07-04 16:14:47 +08:00
- <b>Topics related to alignment issues</b>
- \ref TopicUnalignedArrayAssert
- \ref TopicFixedSizeVectorizable
- \ref TopicStlContainers
- \ref TopicStructHavingEigenMembers
- \ref TopicPassingByValue
- \ref TopicWrongStackAlignment
2010-06-27 04:42:14 +08:00
2007-12-21 15:30:15 +08:00
2009-02-04 23:37:00 +08:00
Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>.
2007-12-21 15:30:15 +08:00
*/
2008-06-03 02:27:37 +08:00
2008-06-03 03:29:23 +08:00
}