aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Overview.dox
Commit message (Collapse)AuthorAge
* Doc: remove link to porting guideGravatar Gael Guennebaud2019-01-17
|
* Doc: split customizing-eigen page into sub-pages and re-structure a bit the ↵Gravatar Gael Guennebaud2016-08-30
| | | | different topics
* fix a weird bug where a space was missing before a linkGravatar Thomas Capricelli2013-03-19
|
* Remove TOC numbering, and minor improvement in overview.Gravatar Gael Guennebaud2013-01-12
|
* fix typoGravatar Thomas Capricelli2013-01-06
|
* Update the overview page to reflect the new organisationGravatar Gael Guennebaud2013-01-05
|
* Big changes in Eigen documentation:Gravatar Gael Guennebaud2013-01-05
| | | | | | | | | | | | | | | | | | | | | | - Organize the documentation into "chapters". - Each chapter include many documentation pages, reference pages organized as modules, and a quick reference page. - The "Chapters" tree is created using the defgroup/ingroup mechanism, even for the documentation pages (i.e., .dox files for which I added an \eigenManualPage macro that we can switch between \page or \defgroup ). - Add a "General topics" entry for all pages that do not fit well in the previous "chapters". - The highlevel struture is managed by a new eigendoxy_layout.xml file. - remove the "index" and quite useless pages (namespace list, class hierarchy, member list, file list, etc.) - add the javascript search-engine. - add the "treeview" panel. - remove \tableofcontents (replace them by a custom \eigenAutoToc macro to be able to easily re-enable if needed). - add javascript to automatically generate a TOC from the h1/h2 tags of the current page, and put the TOC in the left side panel. - overload various javascript function generated by doxygen to: - remove the root of the treeview - remove links to section/subsection from the treeview - automatically expand the "Chapters" section - automatically expand the current section - adjust the height of the treeview to take into account the TOC - always use the default .css file, eigendoxy.css now only includes our modifications - use Doxyfile to specify our logo - remove cross references to unsupported modules (temporarily)
* add the multithreading topic in the topic listGravatar Gael Guennebaud2012-06-21
|
* The sparse quick reference guide is not readyGravatar Desire NUENTSA2012-05-25
|
* Add a preliminary reference guide on sparse interfaceGravatar Desire NUENTSA2012-05-25
|
* Add a tutorial page on the Map class, and add a section to ↵Gravatar Tim Holy2012-02-08
| | | | FunctionsTakingEigenTypes about multiple-argument functions and the pitfalls when using Map/Expression types.
* add a "using MKL" documentation page, add a minimal documentation of PARDISO ↵Gravatar Gael Guennebaud2011-12-09
| | | | wrapper classes, refine a bit the EIGEN_USE_* logic
* Automatically produce a tgz archive of the documentation.Gravatar Gael Guennebaud2011-11-05
|
* Write page on template and typename keywords in C++.Gravatar Jitse Niesen2011-09-10
| | | | | | | After yet another question on the forum, I decided to write something on this common issue. Now we just need to link to this and get people to read it. Thanks to mattb on the forum for some links. Caveat: IANALL (I am not a language lawyer).
* Write topic page for storage orders.Gravatar Jitse Niesen2011-02-12
|
* Move section on preprocessor directives from I00 to its own page.Gravatar Jitse Niesen2010-12-27
|
* Added a tutorial on writing functions taking Eigen types.Gravatar Hauke Heibel2010-08-04
|
* Add page giving an overview of the class hierarchy.Gravatar Jitse Niesen2010-08-02
| | | | | | | This is mostly copied from the wiki, which in turn copies Benoit's email at http://listengine.tuxfamily.org/lists.tuxfamily.org/eigen/2010/06/msg00576.html I used ASCII art for the inheritance diagrams for now, but I don't mind moving to GraphViz/dot as discussed earlier.
* Documentation: Start special topic page on aliasing.Gravatar Jitse Niesen2010-07-31
|
* Reductions/Broadcasting/Visitor Tutorial added to indexGravatar Carlos Becker2010-07-08
|
* Various documentation improvements.Gravatar Jitse Niesen2010-07-06
| | | | | | | * 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 :)
* fix the overview page and add mention that the wrong stack alignment issue ↵Gravatar Benoit Jacob2010-07-06
| | | | may have been solved by gcc 4.5
* Improve documentation, mostly by adding links to Quick Start Guide.Gravatar Jitse Niesen2010-07-05
|
* update topic page on productsGravatar Gael Guennebaud2010-07-04
|
* * update the general TOCGravatar Gael Guennebaud2010-07-04
| | | | | * integrate the old geometry/sparse tutorial into the new one (they are better than nothing) * remove the old tutorial on the core module
* Added Block tutorial to docs indexGravatar Carlos Becker2010-06-29
|
* update the main page and add a TOCGravatar Gael Guennebaud2010-06-26
|
* * implement the corner() API change: new methods topLeftCorner() etcGravatar Benoit Jacob2010-04-22
| | | | | | | | * 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
* started a page on the porting from Eigen2 to 3, updated a bit the tutorialGravatar Gael Guennebaud2010-01-06
|
* Documentation clean up.Gravatar Jitse Niesen2009-12-08
| | | | | | | | * remove non-existant reference to CwiseAll * define \householder_module (used in HouseholderSequence.h) * update I01_TopicLazyEvaluation.dox - Product is now called GeneralProduct * remove reference to list of examples which was deleted ages ago * rename PartialLU_solve.cpp snippet to PartialPivLU_solve.cpp
* add the ASCII quick reference made by KierGravatar Gael Guennebaud2009-02-18
|
* setup the unsupported directory structure.Gravatar Gael Guennebaud2009-02-04
| | | | | | | | 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.
* * Started a tutorial page for sparse matrix.Gravatar Gael Guennebaud2009-01-16
| | | | * Updated Mainpage.dox's directives used by kde's scripts
* * block() for vectors ---> segment()Gravatar Benoit Jacob2008-09-15
| | | | * documentation improvements, especially in quickstart guide
* tweak root/Mainpage.dox to make it compatible with kde's doxygen.sh scriptGravatar Gael Guennebaud2008-08-29
plus some hacks to compile the examples from doxygen... Hopefully, api.kde.org/eigen2 will be beautiful by tomorrow....