From: Wolfgang Bangerth Date: Tue, 13 Feb 2024 02:47:59 +0000 (-0700) Subject: Clarify the documentation of IndexSet::is_empty(). X-Git-Tag: relicensing~41^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=89ec3273e0a98a69fcd62764348b577d48fffaa3;p=dealii.git Clarify the documentation of IndexSet::is_empty(). --- diff --git a/include/deal.II/base/index_set.h b/include/deal.II/base/index_set.h index 8cc267ebba..9605490868 100644 --- a/include/deal.II/base/index_set.h +++ b/include/deal.II/base/index_set.h @@ -255,6 +255,11 @@ public: /** * Return whether the index set stored by this object contains no elements. * This is similar, but faster than checking n_elements() == 0. + * + * Note that a set being empty does not imply that the size of the + * index space must be zero. Rather, this function returns `true` if + * the subset of indices in the index space is the empty set, + * regardless of the size of the index space. */ bool is_empty() const;