eigen/unsupported/Eigen/NumericalDiff

71 lines
2.5 KiB
Plaintext
Raw Normal View History

// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2009 Thomas Capricelli <orzel@freehackers.org>
//
// Eigen is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// Alternatively, you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of
// the License, or (at your option) any later version.
//
// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License and a copy of the GNU General Public License along with
// Eigen. If not, see <http://www.gnu.org/licenses/>.
#ifndef EIGEN_NUMERICALDIFF_MODULE
#define EIGEN_NUMERICALDIFF_MODULE
#include <Eigen/Core>
namespace Eigen {
/** \ingroup Unsupported_modules
* \defgroup NumericalDiff_Module Numerical differentiation module
2009-11-09 13:45:27 +08:00
*
* \code
* #include <unsupported/Eigen/NumericalDiff>
* \endcode
*
* See http://en.wikipedia.org/wiki/Numerical_differentiation
*
2009-11-09 10:07:36 +08:00
* Warning : this should NOT be confused with automatic differentiation, which
2009-11-09 11:52:47 +08:00
* is a different method and has its own module in Eigen : \ref
* AutoDiff_Module.
2009-11-09 10:07:36 +08:00
*
2009-11-09 13:45:27 +08:00
* Currently only "Forward" and "Central" schemes are implemented. Those
2009-11-09 11:21:45 +08:00
* 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
* external library. It is very easy for you to write a functor
* using such software, and the purpose is quite orthogonal to what we
* want to achieve with Eigen.
*
* This is why we will not provide wrappers for every great numerical
* differentiation software that exist, but should rather stick with those
2009-11-09 11:21:45 +08:00
* basic ones, that still are useful for testing.
*
2009-11-11 04:33:36 +08:00
* Also, the \ref NonLinearOptimization_Module needs this in order to
2009-11-09 11:21:45 +08:00
* provide full features compatibility with the original (c)minpack
* package.
*
*/
//@{
#include "src/NumericalDiff/NumericalDiff.h"
//@}
}
#endif // EIGEN_NUMERICALDIFF_MODULE