From: Denis Davydov Date: Tue, 15 May 2018 06:42:20 +0000 (+0200) Subject: update documentation X-Git-Tag: v9.1.0-rc1~1144^2~1 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7eaf9a212adb51831488b116e0a8c2407a158370;p=dealii.git update documentation --- diff --git a/include/deal.II/lac/sparsity_pattern.h b/include/deal.II/lac/sparsity_pattern.h index a8bd82b187..2767470e20 100644 --- a/include/deal.II/lac/sparsity_pattern.h +++ b/include/deal.II/lac/sparsity_pattern.h @@ -150,7 +150,11 @@ namespace SparsityPatternIterators size_type index () const; /** - * Return global index in sparsity pattern. + * This function returns the how-many'th entry within the entire sparsity + * pattern the current iterator points to. While the order of entries in + * a sparsity pattern is generally not important, this function allows + * indexing entries of the sparsity pattern using a linear index. + * * This function can only be called for entries for which is_valid_entry() * is true. */