]> https://gitweb.dealii.org/ - dealii.git/commitdiff
update documentation
authorDenis Davydov <davydden@gmail.com>
Tue, 15 May 2018 06:42:20 +0000 (08:42 +0200)
committerDenis Davydov <davydden@gmail.com>
Tue, 15 May 2018 06:42:20 +0000 (08:42 +0200)
include/deal.II/lac/sparsity_pattern.h

index a8bd82b187a46deb67efd1b1e48ad1aa9c328b98..2767470e20d62067cc607bc0ed8274d3da6ab7b9 100644 (file)
@@ -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.
      */

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.