diff options
author | 2010-08-10 11:37:23 +0100 | |
---|---|---|
committer | 2010-08-10 11:37:23 +0100 | |
commit | 76fbe94279bda314e717cb3f98b46b253d081993 (patch) | |
tree | 3610b5e67431da5956036c4cb0e4bbaae1afc33c /Eigen/src/Core/util | |
parent | 530b3287695e136269eb10c553bb90392ef9a6ba (diff) |
Document EIGEN_NO_DEBUG macro.
I needed some doxygen tricks to get this to work, so it may not be worth it.
Diffstat (limited to 'Eigen/src/Core/util')
-rw-r--r-- | Eigen/src/Core/util/Macros.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Eigen/src/Core/util/Macros.h b/Eigen/src/Core/util/Macros.h index 7600cc3e7..2da9ab291 100644 --- a/Eigen/src/Core/util/Macros.h +++ b/Eigen/src/Core/util/Macros.h @@ -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 |