aboutsummaryrefslogtreecommitdiffhomepage
path: root/unsupported/Eigen/NumericalDiff
diff options
context:
space:
mode:
authorGravatar Thomas Capricelli <orzel@freehackers.org>2009-11-09 04:21:45 +0100
committerGravatar Thomas Capricelli <orzel@freehackers.org>2009-11-09 04:21:45 +0100
commitde195e0e7827729300aa7b431fc183ff087eb83d (patch)
tree4db1087669dae0a127488df66546d3cec029fb93 /unsupported/Eigen/NumericalDiff
parentac8f7d8c9c10b33d74dc0922deb2c5e18890312d (diff)
some more documentation
Diffstat (limited to 'unsupported/Eigen/NumericalDiff')
-rw-r--r--unsupported/Eigen/NumericalDiff16
1 files changed, 16 insertions, 0 deletions
diff --git a/unsupported/Eigen/NumericalDiff b/unsupported/Eigen/NumericalDiff
index 16e9f629a..3a8bc3287 100644
--- a/unsupported/Eigen/NumericalDiff
+++ b/unsupported/Eigen/NumericalDiff
@@ -36,6 +36,22 @@ namespace Eigen {
* Warning : this should NOT be confused with automatic differentiation, which
* is a different method and has its own module in Eigen.
*
+ * Currently only "Forward" and "Central" scheme 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
+ * 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
+ * differenciation software that exist, but should rather stick with those
+ * basic ones, that still are useful for testing.
+ *
+ * Also, the module "Non linear optimization" needs this in order to
+ * provide full features compatibility with the original (c)minpack
+ * package.
+ *
* \code
* #include <unsupported/Eigen/NumericalDiff>
* \endcode