Document EIGEN_NO_DEBUG macro.

I needed some doxygen tricks to get this to work, so it may not be worth it.
This commit is contained in:
Jitse Niesen
2010-08-10 11:37:23 +01:00
parent 530b328769
commit 76fbe94279
5 changed files with 26 additions and 7 deletions

View File

@@ -109,6 +109,19 @@
#define EIGEN_DEBUG_VAR(x) std::cerr << #x << " = " << x << std::endl;
#ifdef EIGEN_PARSED_BY_DOXYGEN
/** \def EIGEN_NO_DEBUG
* \ingroup Core_Module
* \brief If defined, Eigen's assertions are disabled.
* \details Disabling run-time assertions improves the performance, but it is dangerous because the
* assertions guard against programming errors. By default, the EIGEN_NO_DEBUG macro is not defined and
* Eigen's run-time assertions are thus enabled. However, if the NDEBUG macro is defined (this is a
* standard C++ macro which disables all asserts), then the EIGEN_NO_DEBUG macro will also be defined, and
* so Eigen's assertions will also be disabled.
*/
#define EIGEN_NO_DEBUG
#endif
#ifdef NDEBUG
# ifndef EIGEN_NO_DEBUG
# define EIGEN_NO_DEBUG