remove the 'Unsupported Modules' meta module

This commit is contained in:
Gael Guennebaud 2013-01-11 10:40:35 +01:00
parent 109cbb6ad3
commit b0cb5e6d48
19 changed files with 86 additions and 46 deletions

View File

@ -44,7 +44,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup AdolcForward_Module Adolc forward module * \defgroup AdolcForward_Module Adolc forward module
* This module provides support for adolc's adouble type in forward mode. * This module provides support for adolc's adouble type in forward mode.
* ADOL-C is a C++ automatic differentiation library, * ADOL-C is a C++ automatic differentiation library,

View File

@ -14,7 +14,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup AlignedVector3_Module Aligned vector3 module * \defgroup AlignedVector3_Module Aligned vector3 module
* *
* \code * \code

View File

@ -1,3 +1,11 @@
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
//
// 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/.
#ifndef EIGEN_ARPACKSUPPORT_MODULE_H #ifndef EIGEN_ARPACKSUPPORT_MODULE_H
#define EIGEN_ARPACKSUPPORT_MODULE_H #define EIGEN_ARPACKSUPPORT_MODULE_H
@ -5,17 +13,12 @@
#include <Eigen/src/Core/util/DisableStupidWarnings.h> #include <Eigen/src/Core/util/DisableStupidWarnings.h>
/** \defgroup Eigenvalues_Module Eigenvalues module /** \defgroup ArpackSupport_Module Arpack support module
* *
* * This module provides a wrapper to Arpack, a library for sparse eigenvalue decomposition.
*
* This module mainly provides various eigenvalue solvers.
* This module also provides some MatrixBase methods, including:
* - MatrixBase::eigenvalues(),
* - MatrixBase::operatorNorm()
* *
* \code * \code
* #include <Eigen/Eigenvalues> * #include <Eigen/ArpackSupport>
* \endcode * \endcode
*/ */

View File

@ -12,7 +12,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup AutoDiff_Module Auto Diff module * \defgroup AutoDiff_Module Auto Diff module
* *
* This module features forward automatic differentation via a simple * This module features forward automatic differentation via a simple

View File

@ -18,7 +18,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup BVH_Module BVH module * \defgroup BVH_Module BVH module
* \brief This module provides generic bounding volume hierarchy algorithms * \brief This module provides generic bounding volume hierarchy algorithms
* and reference tree implementations. * and reference tree implementations.

View File

@ -16,7 +16,7 @@
#include <Eigen/Core> #include <Eigen/Core>
/** \ingroup Unsupported_modules /**
* \defgroup FFT_Module Fast Fourier Transform module * \defgroup FFT_Module Fast Fourier Transform module
* *
* \code * \code

View File

@ -12,7 +12,7 @@
#include <Eigen/Sparse> #include <Eigen/Sparse>
/** \ingroup Unsupported_modules /**
* \defgroup IterativeSolvers_Module Iterative solvers module * \defgroup IterativeSolvers_Module Iterative solvers module
* This module aims to provide various iterative linear and non linear solver algorithms. * This module aims to provide various iterative linear and non linear solver algorithms.
* It currently provides: * It currently provides:

View File

@ -1,3 +1,11 @@
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
//
// 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/.
#ifndef EIGEN_KRONECKER_PRODUCT_MODULE_H #ifndef EIGEN_KRONECKER_PRODUCT_MODULE_H
#define EIGEN_KRONECKER_PRODUCT_MODULE_H #define EIGEN_KRONECKER_PRODUCT_MODULE_H
@ -7,7 +15,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup KroneckerProduct_Module KroneckerProduct module * \defgroup KroneckerProduct_Module KroneckerProduct module
* *
* This module contains an experimental Kronecker product implementation. * This module contains an experimental Kronecker product implementation.

View File

@ -20,8 +20,8 @@
#include <Eigen/SPQRSupport> #include <Eigen/SPQRSupport>
#endif #endif
/** \ingroup NonLinearOptimization_modules /**
* \defgroup LevenbergMarquardt_Module Levenberg-Marquardt optimization module * \defgroup LevenbergMarquardt_Module Levenberg-Marquardt module
* *
* \code * \code
* #include </Eigen/LevenbergMarquardt> * #include </Eigen/LevenbergMarquardt>

View File

@ -17,21 +17,20 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup MPRealSupport_Module MPFRC++ Support module * \defgroup MPRealSupport_Module MPFRC++ Support module
* * \code
* \code * #include <Eigen/MPRealSupport>
* #include <Eigen/MPRealSupport> * \endcode
* \endcode *
* * This module provides support for multi precision floating point numbers
* This module provides support for multi precision floating point numbers * via the <a href="http://www.holoborodko.com/pavel/mpfr">MPFR C++</a>
* via the <a href="http://www.holoborodko.com/pavel/mpfr">MPFR C++</a> * library which itself is built upon <a href="http://www.mpfr.org/">MPFR</a>/<a href="http://gmplib.org/">GMP</a>.
* library which itself is built upon <a href="http://www.mpfr.org/">MPFR</a>/<a href="http://gmplib.org/">GMP</a>. *
* * You can find a copy of MPFR C++ that is known to be compatible in the unsupported/test/mpreal folder.
* You can find a copy of MPFR C++ that is known to be compatible in the unsupported/test/mpreal folder. *
* * Here is an example:
* Here is an example: *
*
\code \code
#include <iostream> #include <iostream>
#include <Eigen/MPRealSupport> #include <Eigen/MPRealSupport>
@ -55,8 +54,8 @@ int main()
return 0; return 0;
} }
\endcode \endcode
* *
*/ */
template<> struct NumTraits<mpfr::mpreal> template<> struct NumTraits<mpfr::mpreal>
: GenericNumTraits<mpfr::mpreal> : GenericNumTraits<mpfr::mpreal>

View File

@ -20,7 +20,7 @@
#include <Eigen/LU> #include <Eigen/LU>
#include <Eigen/Eigenvalues> #include <Eigen/Eigenvalues>
/** \ingroup Unsupported_modules /**
* \defgroup MatrixFunctions_Module Matrix functions module * \defgroup MatrixFunctions_Module Matrix functions module
* \brief This module aims to provide various methods for the computation of * \brief This module aims to provide various methods for the computation of
* matrix functions. * matrix functions.

View File

@ -1,3 +1,11 @@
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
//
// 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/.
#ifndef EIGEN_MOREVECTORIZATION_MODULE_H #ifndef EIGEN_MOREVECTORIZATION_MODULE_H
#define EIGEN_MOREVECTORIZATION_MODULE_H #define EIGEN_MOREVECTORIZATION_MODULE_H
@ -5,7 +13,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup MoreVectorization More vectorization module * \defgroup MoreVectorization More vectorization module
*/ */

View File

@ -17,7 +17,7 @@
#include <Eigen/QR> #include <Eigen/QR>
#include <unsupported/Eigen/NumericalDiff> #include <unsupported/Eigen/NumericalDiff>
/** \ingroup Unsupported_modules /**
* \defgroup NonLinearOptimization_Module Non linear optimization module * \defgroup NonLinearOptimization_Module Non linear optimization module
* *
* \code * \code

View File

@ -14,7 +14,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup NumericalDiff_Module Numerical differentiation module * \defgroup NumericalDiff_Module Numerical differentiation module
* *
* \code * \code

View File

@ -15,7 +15,7 @@
namespace Eigen { namespace Eigen {
/** \ingroup Unsupported_modules /**
* \defgroup OpenGLSUpport_Module OpenGL Support module * \defgroup OpenGLSUpport_Module OpenGL Support module
* *
* This module provides wrapper functions for a couple of OpenGL functions * This module provides wrapper functions for a couple of OpenGL functions

View File

@ -1,3 +1,11 @@
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
//
// 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/.
#ifndef EIGEN_POLYNOMIALS_MODULE_H #ifndef EIGEN_POLYNOMIALS_MODULE_H
#define EIGEN_POLYNOMIALS_MODULE_H #define EIGEN_POLYNOMIALS_MODULE_H
@ -16,11 +24,8 @@
#undef EIGEN_HIDE_HEAVY_CODE #undef EIGEN_HIDE_HEAVY_CODE
#endif #endif
/** \ingroup Unsupported_modules /**
* \defgroup Polynomials_Module Polynomials module * \defgroup Polynomials_Module Polynomials module
*
*
*
* \brief This module provides a QR based polynomial solver. * \brief This module provides a QR based polynomial solver.
* *
* To use this module, add * To use this module, add

View File

@ -1,3 +1,11 @@
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
//
// 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/.
#ifndef EIGEN_SKYLINE_MODULE_H #ifndef EIGEN_SKYLINE_MODULE_H
#define EIGEN_SKYLINE_MODULE_H #define EIGEN_SKYLINE_MODULE_H
@ -11,7 +19,7 @@
#include <cstring> #include <cstring>
#include <algorithm> #include <algorithm>
/** \ingroup Unsupported_modules /**
* \defgroup Skyline_Module Skyline module * \defgroup Skyline_Module Skyline module
* *
* *

View File

@ -1,3 +1,12 @@
// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2008-2009 Gael Guennebaud <g.gael@free.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/.
#ifndef EIGEN_SPARSE_EXTRA_MODULE_H #ifndef EIGEN_SPARSE_EXTRA_MODULE_H
#define EIGEN_SPARSE_EXTRA_MODULE_H #define EIGEN_SPARSE_EXTRA_MODULE_H
@ -17,7 +26,7 @@
#include <google/dense_hash_map> #include <google/dense_hash_map>
#endif #endif
/** \ingroup Unsupported_modules /**
* \defgroup SparseExtra_Module SparseExtra module * \defgroup SparseExtra_Module SparseExtra module
* *
* This module contains some experimental features extending the sparse module. * This module contains some experimental features extending the sparse module.

View File

@ -12,7 +12,7 @@
namespace Eigen namespace Eigen
{ {
/** \ingroup Unsupported_modules /**
* \defgroup Splines_Module Spline and spline fitting module * \defgroup Splines_Module Spline and spline fitting module
* *
* This module provides a simple multi-dimensional spline class while * This module provides a simple multi-dimensional spline class while