few doc fixes

This commit is contained in:
Thomas Capricelli 2009-11-09 06:45:27 +01:00
parent d1cc2745f7
commit 087df89e20
3 changed files with 12 additions and 10 deletions

View File

@ -28,13 +28,13 @@ namespace Eigen {
/** \ingroup Unsupported_modules
* \ref MatrixFunctions_Module */
/** \ingroup Unsupported_modules
* \ref MoreVectorization */
/** \ingroup Unsupported_modules
* \ref NonLinearOptimization_Module */
/** \ingroup Unsupported_modules
* \ref NumericalDiff_Module */
/** \ingroup Unsupported_modules
* \ref MoreVectorization */
} // namespace Eigen

View File

@ -22,8 +22,8 @@
// License and a copy of the GNU General Public License along with
// Eigen. If not, see <http://www.gnu.org/licenses/>.
#ifndef EIGEN_NONLINEAR_MODULE_H
#define EIGEN_NONLINEAR_MODULE_H
#ifndef EIGEN_NONLINEAROPTIMIZATION_MODULE
#define EIGEN_NONLINEAROPTIMIZATION_MODULE
#include <Eigen/Core>
#include <unsupported/Eigen/NumericalDiff>
@ -150,4 +150,4 @@ namespace Eigen {
#endif // EIGEN_NONLINEAR_MODULE_H
#endif // EIGEN_NONLINEAROPTIMIZATION_MODULE

View File

@ -31,13 +31,18 @@ namespace Eigen {
/** \ingroup Unsupported_modules
* \defgroup NumericalDiff_Module Numerical differenciation module
*
* \code
* #include <unsupported/Eigen/NumericalDiff>
* \endcode
*
* See http://en.wikipedia.org/wiki/Numerical_differentiation
*
* Warning : this should NOT be confused with automatic differentiation, which
* is a different method and has its own module in Eigen : \ref
* AutoDiff_Module.
*
* Currently only "Forward" and "Central" scheme are implemented. Those
* Currently only "Forward" and "Central" schemes are implemented. Those
* are basic methods, and there exist some more elaborated way of
* computing such approximates. They are implemented using both
* proprietary and free software, and usually requires linking to an
@ -53,9 +58,6 @@ namespace Eigen {
* provide full features compatibility with the original (c)minpack
* package.
*
* \code
* #include <unsupported/Eigen/NumericalDiff>
* \endcode
*/
//@{