From 7eaf9a212adb51831488b116e0a8c2407a158370 Mon Sep 17 00:00:00 2001 From: Denis Davydov Date: Tue, 15 May 2018 08:42:20 +0200 Subject: [PATCH] update documentation --- include/deal.II/lac/sparsity_pattern.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) 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. */ -- 2.39.5