aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Core/util/Macros.h
diff options
context:
space:
mode:
Diffstat (limited to 'Eigen/src/Core/util/Macros.h')
-rw-r--r--Eigen/src/Core/util/Macros.h13
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