From: wolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Mon, 28 Jan 2002 08:37:16 +0000 (+0000)
Subject: Add some documentation.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1ae0fd188ab0fadb184be4a1952940a19ce38d23;p=dealii-svn.git

Add some documentation.


git-svn-id: https://svn.dealii.org/trunk@5424 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/lac/include/lac/sparsity_pattern.h b/deal.II/lac/include/lac/sparsity_pattern.h
index 525b9c5da5..0c16477b57 100644
--- a/deal.II/lac/include/lac/sparsity_pattern.h
+++ b/deal.II/lac/include/lac/sparsity_pattern.h
@@ -584,7 +584,20 @@ class SparsityPattern : public Subscriptor
 				     /**
 				      * Access to column number field.
 				      * Return the column number of
-				      * the @p{index}th entry in @p{row}.
+				      * the @p{index}th entry in
+				      * @p{row}. Note that the if the
+				      * matrix is square, then the
+				      * first element in each row is
+				      * the diagonal element,
+				      * i.e. @p{column_number(row,0)==row}.
+				      *
+				      * If the sparsity pattern is
+				      * already compressed, then
+				      * (except for the diagonal
+				      * element), the entries are
+				      * sorted by columns,
+				      * i.e. @p{column_number(row,i)}
+				      * @p{<} @p{column_number(row,i+1)}.
 				      */
     unsigned int column_number (const unsigned int row,
 				const unsigned int index) const;