Rev | Line | |
---|
[136] | 1 | namespace Eigen {
|
---|
| 2 |
|
---|
| 3 | /** \mainpage notitle
|
---|
| 4 |
|
---|
| 5 | This is the API documentation for Eigen3. You can <a href="eigen-doc.tgz">download</a> it as a tgz archive for offline reading.
|
---|
| 6 |
|
---|
| 7 | You're already an Eigen2 user? Here is a \link Eigen2ToEigen3 Eigen2 to Eigen3 guide \endlink to help porting your application.
|
---|
| 8 |
|
---|
| 9 | 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.
|
---|
| 10 |
|
---|
| 11 | 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:
|
---|
| 12 | - \link QuickRefPage [QuickRef] Dense matrix and array manipulations \endlink
|
---|
| 13 | - \link SparseQuickRefPage [QuickRef] Sparse linear algebra \endlink
|
---|
| 14 |
|
---|
| 15 | You're a MatLab user? There is also a <a href="AsciiQuickReference.txt">short ASCII reference</a> with Matlab translations.
|
---|
| 16 |
|
---|
| 17 | The \b main \b documentation is organized into \em chapters covering different domains of features.
|
---|
| 18 | 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.
|
---|
| 19 |
|
---|
| 20 | 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...
|
---|
| 21 |
|
---|
| 22 | Finally, do not miss the search engine, useful to quickly get to the documentation of a given class or function.
|
---|
| 23 |
|
---|
| 24 | Want more? Checkout the <a href="unsupported/index.html">\em unsupported \em modules </a> documentation.
|
---|
| 25 |
|
---|
| 26 | */
|
---|
| 27 |
|
---|
| 28 | }
|
---|
Note:
See
TracBrowser
for help on using the repository browser.