2008-06-23 21:25:22 +08:00
|
|
|
#ifndef EIGEN_SPARSE_MODULE_H
|
|
|
|
#define EIGEN_SPARSE_MODULE_H
|
|
|
|
|
Big changes in Eigen documentation:
- 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)
2013-01-05 23:37:11 +08:00
|
|
|
/** defgroup Sparse_modules Sparse modules
|
2009-01-26 21:53:43 +08:00
|
|
|
*
|
2011-11-12 21:11:27 +08:00
|
|
|
* Meta-module including all related modules:
|
|
|
|
* - SparseCore
|
|
|
|
* - OrderingMethods
|
|
|
|
* - SparseCholesky
|
|
|
|
* - IterativeLinearSolvers
|
2009-01-26 21:53:43 +08:00
|
|
|
*
|
|
|
|
* \code
|
2010-06-18 17:28:30 +08:00
|
|
|
* #include <Eigen/Sparse>
|
2009-01-26 21:53:43 +08:00
|
|
|
* \endcode
|
|
|
|
*/
|
|
|
|
|
2011-11-12 21:11:27 +08:00
|
|
|
#include "SparseCore"
|
|
|
|
#include "OrderingMethods"
|
|
|
|
#include "SparseCholesky"
|
|
|
|
#include "IterativeLinearSolvers"
|
2008-12-19 04:48:02 +08:00
|
|
|
|
2008-06-23 21:25:22 +08:00
|
|
|
#endif // EIGEN_SPARSE_MODULE_H
|
2009-12-02 07:00:29 +08:00
|
|
|
|