Warning, /include/eigen3/unsupported/Eigen/NumericalDiff is written in an unsupported language. File is not indexed.
0001 // This file is part of Eigen, a lightweight C++ template library
0002 // for linear algebra.
0003 //
0004 // Copyright (C) 2009 Thomas Capricelli <orzel@freehackers.org>
0005 //
0006 // This Source Code Form is subject to the terms of the Mozilla
0007 // Public License v. 2.0. If a copy of the MPL was not distributed
0008 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
0009
0010 #ifndef EIGEN_NUMERICALDIFF_MODULE
0011 #define EIGEN_NUMERICALDIFF_MODULE
0012
0013 #include "../../Eigen/Core"
0014
0015 namespace Eigen {
0016
0017 /**
0018 * \defgroup NumericalDiff_Module Numerical differentiation module
0019 *
0020 * \code
0021 * #include <unsupported/Eigen/NumericalDiff>
0022 * \endcode
0023 *
0024 * See http://en.wikipedia.org/wiki/Numerical_differentiation
0025 *
0026 * Warning : this should NOT be confused with automatic differentiation, which
0027 * is a different method and has its own module in Eigen : \ref
0028 * AutoDiff_Module.
0029 *
0030 * Currently only "Forward" and "Central" schemes are implemented. Those
0031 * are basic methods, and there exist some more elaborated way of
0032 * computing such approximates. They are implemented using both
0033 * proprietary and free software, and usually requires linking to an
0034 * external library. It is very easy for you to write a functor
0035 * using such software, and the purpose is quite orthogonal to what we
0036 * want to achieve with Eigen.
0037 *
0038 * This is why we will not provide wrappers for every great numerical
0039 * differentiation software that exist, but should rather stick with those
0040 * basic ones, that still are useful for testing.
0041 *
0042 * Also, the \ref NonLinearOptimization_Module needs this in order to
0043 * provide full features compatibility with the original (c)minpack
0044 * package.
0045 *
0046 */
0047 }
0048
0049 //@{
0050
0051 #include "src/NumericalDiff/NumericalDiff.h"
0052
0053 //@}
0054
0055
0056 #endif // EIGEN_NUMERICALDIFF_MODULE
