From e0dbc2913a4f176876ea56f247409ff340c5f1d3 Mon Sep 17 00:00:00 2001 From: Christoph Hertzberg Date: Fri, 16 Aug 2013 16:43:02 +0200 Subject: [PATCH] Documentation of deprecated struct. Closing bug #426. --- Eigen/src/Core/Functors.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Eigen/src/Core/Functors.h b/Eigen/src/Core/Functors.h index 080338617..69d95ea30 100644 --- a/Eigen/src/Core/Functors.h +++ b/Eigen/src/Core/Functors.h @@ -19,7 +19,7 @@ namespace internal { /** \internal * \brief Template functor to compute the sum of two scalars * - * \sa class CwiseBinaryOp, MatrixBase::operator+, class VectorwiseOp, MatrixBase::sum() + * \sa class CwiseBinaryOp, MatrixBase::operator+, class VectorwiseOp, DenseBase::sum() */ template struct scalar_sum_op { EIGEN_EMPTY_STRUCT_CTOR(scalar_sum_op) @@ -39,7 +39,11 @@ struct functor_traits > { }; }; - +/** \internal + * \brief Template specialization to deprecate the summation of boolean expressions. + * This is required to solve Bug 426. + * \sa DenseBase::count(), DenseBase::any(), ArrayBase::cast(), MatrixBase::cast() + */ template<> struct scalar_sum_op : scalar_sum_op { EIGEN_DEPRECATED scalar_sum_op() {}