2013-06-12 03:13:30 +08:00
|
|
|
// This file is part of Eigen, a lightweight C++ template library
|
|
|
|
|
// for linear algebra.
|
|
|
|
|
//
|
|
|
|
|
// Copyright (C) 2008-2013 Gael Guennebaud <gael.guennebaud@inria.fr>
|
|
|
|
|
//
|
|
|
|
|
// This Source Code Form is subject to the terms of the Mozilla
|
|
|
|
|
// Public License v. 2.0. If a copy of the MPL was not distributed
|
|
|
|
|
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
|
|
2011-11-12 22:22:35 +08:00
|
|
|
#ifndef EIGEN_SPARSECHOLESKY_MODULE_H
|
|
|
|
|
#define EIGEN_SPARSECHOLESKY_MODULE_H
|
|
|
|
|
|
|
|
|
|
#include "SparseCore"
|
2013-06-12 03:13:30 +08:00
|
|
|
#include "OrderingMethods"
|
2011-11-12 22:22:35 +08:00
|
|
|
|
2011-11-16 16:27:38 +08:00
|
|
|
#include "src/Core/util/DisableStupidWarnings.h"
|
2011-11-12 22:22:35 +08:00
|
|
|
|
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
|
|
|
/**
|
2011-11-12 22:22:35 +08:00
|
|
|
* \defgroup SparseCholesky_Module SparseCholesky module
|
|
|
|
|
*
|
|
|
|
|
* This module currently provides two variants of the direct sparse Cholesky decomposition for selfadjoint (hermitian) matrices.
|
|
|
|
|
* Those decompositions are accessible via the following classes:
|
|
|
|
|
* - SimplicialLLt,
|
|
|
|
|
* - SimplicialLDLt
|
|
|
|
|
*
|
|
|
|
|
* Such problems can also be solved using the ConjugateGradient solver from the IterativeLinearSolvers module.
|
|
|
|
|
*
|
|
|
|
|
* \code
|
|
|
|
|
* #include <Eigen/SparseCholesky>
|
|
|
|
|
* \endcode
|
|
|
|
|
*/
|
|
|
|
|
|
2013-02-06 18:30:33 +08:00
|
|
|
#ifdef EIGEN_MPL2_ONLY
|
|
|
|
|
#error The SparseCholesky module has nothing to offer in MPL2 only mode
|
|
|
|
|
#endif
|
|
|
|
|
|
2011-11-12 22:22:35 +08:00
|
|
|
#include "src/SparseCholesky/SimplicialCholesky.h"
|
|
|
|
|
|
2013-02-06 18:30:33 +08:00
|
|
|
#ifndef EIGEN_MPL2_ONLY
|
|
|
|
|
#include "src/SparseCholesky/SimplicialCholesky_impl.h"
|
|
|
|
|
#endif
|
|
|
|
|
|
2011-11-16 16:27:38 +08:00
|
|
|
#include "src/Core/util/ReenableStupidWarnings.h"
|
2011-11-12 22:22:35 +08:00
|
|
|
|
|
|
|
|
#endif // EIGEN_SPARSECHOLESKY_MODULE_H
|