diff options
author | Gael Guennebaud <g.gael@free.fr> | 2009-02-04 09:44:44 +0000 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2009-02-04 09:44:44 +0000 |
commit | 44a527dfa50ce9c473cbf1f446b8b6f406d4bc91 (patch) | |
tree | a0f045d2a4c22a38e08e1b1d1ce0e17e630898c7 /unsupported | |
parent | b0dd22cc7271523ba83d2bc8a85504b8445587b5 (diff) |
* classify and sort the doxygen "related pages"
by tweaking the filename and adding 2 categories:
Troubleshooting and Advanced
* use the EXCLUDE_SYMBOLS to clean the class list
(insteaded of a homemade bash script)
* remove the broken "exemple list"
* re-structure the unsupported directory as mentionned in the ML and
integrate the doc as follow:
- snippets of the unsupported directory are directly imported from the
main snippets/CMakefile.txt (no need to duplicate code)
- add a top level "Unsupported modules" group
- unsupported modules have to defined their own sub group and nest it
using \ingroup Unsupported_modules
- then a pair of //@{ //@} will put everything in the submodule
- this is just a proposal !
Diffstat (limited to 'unsupported')
-rw-r--r-- | unsupported/Eigen/AdolcForward (renamed from unsupported/AdolcSupport/AdolcForward.h) | 56 | ||||
-rw-r--r-- | unsupported/doc/unsupported.dox | 15 |
2 files changed, 55 insertions, 16 deletions
diff --git a/unsupported/AdolcSupport/AdolcForward.h b/unsupported/Eigen/AdolcForward index 0a55311a8..1845cb917 100644 --- a/unsupported/AdolcSupport/AdolcForward.h +++ b/unsupported/Eigen/AdolcForward @@ -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_ADLOC_FORWARD_H -#define EIGEN_ADLOC_FORWARD_H +#ifndef EIGEN_ADLOC_FORWARD +#define EIGEN_ADLOC_FORWARD //-------------------------------------------------------------------------------- // @@ -59,20 +59,29 @@ namespace Eigen { -template<> struct NumTraits<adtl::adouble> -{ - typedef adtl::adouble Real; - typedef adtl::adouble FloatingPoint; - enum { - IsComplex = 0, - HasFloatingPoint = 1, - ReadCost = 1, - AddCost = 1, - MulCost = 1 - }; -}; +namespace unsupported { -} +/** \ingroup Unsupported_modules + * \defgroup AdolcForward_Module Adolc forward module + * This module provides support for adolc's adouble type in forward mode. + * ADOL-C is a C++ automatic differentiation library, + * see http://www.math.tu-dresden.de/~adol-c/ for more information. + * It mainly consists in: + * - a struct Eigen::NumTraits<adtl::adouble> specialization + * - overloads of ei_* math function for adtl::adouble type. + * + * Note that the maximal number of directions is controlled by + * the preprocessor token NUMBER_DIRECTIONS. The default is 2. + * + * \code + * #include <unsupported/Eigen/AdolcSupport> + * \endcode + */ + //@{ + +} // namespace unsupported + +} // namespace Eigen // the Adolc's type adouble is defined in the adtl namespace // therefore, the following ei_* functions *must* be defined @@ -93,4 +102,19 @@ namespace adtl { } -#endif // EIGEN_ADLOC_FORWARD_H +namespace Eigen { namespace unsupported { /*@}*/ } } + +template<> struct EigenNumTraits<adtl::adouble> +{ + typedef adtl::adouble Real; + typedef adtl::adouble FloatingPoint; + enum { + IsComplex = 0, + HasFloatingPoint = 1, + ReadCost = 1, + AddCost = 1, + MulCost = 1 + }; +}; + +#endif // EIGEN_ADLOC_FORWARD diff --git a/unsupported/doc/unsupported.dox b/unsupported/doc/unsupported.dox new file mode 100644 index 000000000..abef263ad --- /dev/null +++ b/unsupported/doc/unsupported.dox @@ -0,0 +1,15 @@ + +namespace Eigen { + +namespace unsupported { + +/** \defgroup Unsupported_modules Unsupported modules + * + * The unsupported modules are contributions from various users. They are + * provided "as is", without any support. Nevertheless, they are subject to be + * included in Eigen in the future. + */ + +} // namespace unsupported + +} // namespace Eigen
\ No newline at end of file |