diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2013-04-09 11:27:54 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2013-04-09 11:27:54 +0200 |
| commit | d7f3cfb56e7852534a08db23075482dcb11ba47b (patch) | |
| tree | 65d3c6570e44f20b81120768ef4e41e49c5d0e52 /Eigen/src/Core/Redux.h | |
| parent | 3cb6e21f80150345d8d8eeaf75b185e66a4a3c95 (diff) | |
bug #564: document the fact that minCoeff/maxCoeff members have undefined behavior if the matrix contains NaN.
Diffstat (limited to 'Eigen/src/Core/Redux.h')
| -rw-r--r-- | Eigen/src/Core/Redux.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/Eigen/src/Core/Redux.h b/Eigen/src/Core/Redux.h index b7ce7c658..50548fa9a 100644 --- a/Eigen/src/Core/Redux.h +++ b/Eigen/src/Core/Redux.h @@ -330,7 +330,8 @@ DenseBase<Derived>::redux(const Func& func) const ::run(derived(), func); } -/** \returns the minimum of all coefficients of *this +/** \returns the minimum of all coefficients of \c *this. + * \warning the result is undefined if \c *this contains NaN. */ template<typename Derived> EIGEN_STRONG_INLINE typename internal::traits<Derived>::Scalar @@ -339,7 +340,8 @@ DenseBase<Derived>::minCoeff() const return this->redux(Eigen::internal::scalar_min_op<Scalar>()); } -/** \returns the maximum of all coefficients of *this +/** \returns the maximum of all coefficients of \c *this. + * \warning the result is undefined if \c *this contains NaN. */ template<typename Derived> EIGEN_STRONG_INLINE typename internal::traits<Derived>::Scalar |