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 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 GettingStarted
  - \b Tutorial
    - \ref TutorialMatrixClass
    - \ref TutorialMatrixArithmetic
    - \ref TutorialArrayClass
    - \ref TutorialBlockOperations
    - "Dense linear algebra"
    - "Geometry"
    - "Reductions, visitors, and broadcasting"
    - "Sparse matrices"
  - \ref QuickRefPage
  - \ref Eigen2ToEigen3
   

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
update the main page and add a TOC 2010-06-27 04:42:14 +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 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 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 main page and add a TOC 2010-06-27 04:42:14 +08:00			`- "Dense linear algebra"`
			`- "Geometry"`
			`- "Reductions, visitors, and broadcasting"`
			`- "Sparse matrices"`
			`- \ref QuickRefPage`
			`- \ref Eigen2ToEigen3`

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			`}`