Better comment

2015-06-17 09:05:02 -07:00 · 2015-06-17 09:05:02 -07:00 · 178c1aec88
parent 32044eaac8
commit 178c1aec88
1 changed files with 6 additions and 1 deletions
--- a/gtsam/nonlinear/AdaptAutoDiff.h
+++ b/gtsam/nonlinear/AdaptAutoDiff.h
@ -65,7 +65,12 @@ struct Canonical {
  }
 };

-/// Adapt ceres-style autodiff
+/**
+ * The AdaptAutoDiff class uses ceres-style autodiff to adapt a ceres-style
+ * Function evaluation, i.e., a function F that defines an operator
+ *   template<typename T> bool operator()(const T* const, const T* const, T* predicted) const;
+ * For now only binary operators are supported.
+ */
 template<typename F, typename T, typename A1, typename A2>
 class AdaptAutoDiff {