From: Timo Heister <timo.heister@gmail.com>
Date: Sun, 22 Feb 2015 02:00:20 +0000 (-0500)
Subject: document SparsityPattern::bandwidth
X-Git-Tag: v8.3.0-rc1~436^2~1
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8086ede570185a2d4387d1d0559369bda6839b51;p=dealii.git

document SparsityPattern::bandwidth
---

diff --git a/include/deal.II/lac/sparsity_pattern.h b/include/deal.II/lac/sparsity_pattern.h
index 1f5f31ae97..011cdbb472 100644
--- a/include/deal.II/lac/sparsity_pattern.h
+++ b/include/deal.II/lac/sparsity_pattern.h
@@ -755,7 +755,10 @@ public:
    * Compute the bandwidth of the matrix represented by this structure. The
    * bandwidth is the maximum of $|i-j|$ for which the index pair $(i,j)$
    * represents a nonzero entry of the matrix. Consequently, the maximum
-   * bandwidth a $n\times m$ matrix can have is $\max\{n-1,m-1\}$.
+   * bandwidth a $n\times m$ matrix can have is $\max\{n-1,m-1\}$, a diagonal
+   * matrix has bandwidth 0, and there are at most $2*q+1$ entries per row if
+   * the bandwidth is $q$. The returned quantity is sometimes called "half
+   * bandwidth" in the literature.
    */
   size_type bandwidth () const;