eigen/doc/Overview.dox

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 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
    - Coming soon: "Reductions, visitors, and broadcasting"
    - \ref TutorialGeometry
    - \ref TutorialSparse
  - \ref QuickRefPage
  - <b>Advanced topics</b>
    - \ref TopicLazyEvaluation
    - \ref TopicLinearAlgebraDecompositions
    - \ref TopicCustomizingEigen
    - \ref TopicInsideEigenExample
    - \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>.

*/

}
doc improvements: fix linking in Mainpage.dox, improved Doxyfile.in 2008-06-03 02:27:37 +08:00			`namespace Eigen {`

many small fixes and documentation improvements, this should be alpha5. 2008-05-29 11:12:30 +08:00			`o /** \mainpage Eigen`
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs 2007-12-21 15:30:15 +08:00
update the main page and add a TOC 2010-06-27 04:42:14 +08:00			`<div class="eimainmenu">`
			`\ref GettingStarted "Getting started"`
			`\| \ref TutorialMatrixClass "Tutorial"`
			`\| \ref QuickRefPage "Short reference"`
* move memory related stuff to util/Memory.h * clean ugly doxygen inheritence of expressions * keep improving the documentation... slowly ! 2008-08-27 03:12:23 +08:00			`</div>`

started a page on the porting from Eigen2 to 3, updated a bit the tutorial 2010-01-06 20:56:04 +08:00			`This is the API documentation for Eigen3.`

* implement the corner() API change: new methods topLeftCorner() etc * get rid of BlockReturnType: it was not needed, and code was not always using it consistently anyway * add topRows(), leftCols(), bottomRows(), rightCols() * add corners unit-test covering all of that * adapt docs, expand "porting from eigen 2 to 3" * adapt Eigen2Support 2010-04-23 02:11:18 +08:00			`Eigen2 users: here is a \ref Eigen2ToEigen3 guide to help porting your application.`
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs 2007-12-21 15:30:15 +08:00
Improve documentation, mostly by adding links to Quick Start Guide. 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.
update the main page and add a TOC 2010-06-27 04:42:14 +08:00
			`\b Table \b of \b contents`
* update the general TOC * integrate the old geometry/sparse tutorial into the new one (they are better than nothing) * remove the old tutorial on the core module 2010-07-04 16:14:47 +08:00			`- \ref Eigen2ToEigen3`
update the main page and add a TOC 2010-06-27 04:42:14 +08:00			`- \ref GettingStarted`
			`- \b Tutorial`
			`- \ref TutorialMatrixClass`
			`- \ref TutorialMatrixArithmetic`
			`- \ref TutorialArrayClass`
Added Block tutorial to docs index 2010-06-29 21:23:49 +08:00			`- \ref TutorialBlockOperations`
* update the general TOC * integrate the old geometry/sparse tutorial into the new one (they are better than nothing) * remove the old tutorial on the core module 2010-07-04 16:14:47 +08:00			`- \ref TutorialAdvancedInitialization`
			`- \ref TutorialLinearAlgebra`
Various documentation improvements. * Add short documentation for Array class * Put all classes explicitly in Core module (where applicable) * Section on Modules in Quick Reference Guide * Put Page 7 after Page 6 in Contents :) 2010-07-06 20:10:08 +08:00			`- Coming soon: "Reductions, visitors, and broadcasting"`
* update the general TOC * integrate the old geometry/sparse tutorial into the new one (they are better than nothing) * remove the old tutorial on the core module 2010-07-04 16:14:47 +08:00			`- \ref TutorialGeometry`
fix the overview page and add mention that the wrong stack alignment issue may have been solved by gcc 4.5 2010-07-06 12:50:16 +08:00			`- \ref TutorialSparse`
update the main page and add a TOC 2010-06-27 04:42:14 +08:00			`- \ref QuickRefPage`
update topic page on products 2010-07-04 16:37:32 +08:00			`- <b>Advanced topics</b>`
* update the general TOC * integrate the old geometry/sparse tutorial into the new one (they are better than nothing) * remove the old tutorial on the core module 2010-07-04 16:14:47 +08:00			`- \ref TopicLazyEvaluation`
			`- \ref TopicLinearAlgebraDecompositions`
			`- \ref TopicCustomizingEigen`
			`- \ref TopicInsideEigenExample`
update topic page on products 2010-07-04 16:37:32 +08:00			`- \ref TopicWritingEfficientProductExpression`
* update the general TOC * integrate the old geometry/sparse tutorial into the new one (they are better than nothing) * remove the old tutorial on the core module 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`

update the main page and add a TOC 2010-06-27 04:42:14 +08:00
move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs 2007-12-21 15:30:15 +08:00
setup the unsupported directory structure. The unsupported module documentation is automatically generated in: build/doc/unsupported/ with bidirectional cross references. I leave a class Foo in AdolcForward module to illustrate the cross-reference behavior. I will remove it in the next commit. 2009-02-04 23:37:00 +08:00			`Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>.`

move the documentation to doc/, add dummy documentation to srcdir/ compiling to an explanation of how to generate the docs 2007-12-21 15:30:15 +08:00			`*/`
doc improvements: fix linking in Mainpage.dox, improved Doxyfile.in 2008-06-03 02:27:37 +08:00
work around Doxygen bug triggered by r814874, which caused many classes to disappear from the docs. 2008-06-03 03:29:23 +08:00			`}`