From 1ae0fd188ab0fadb184be4a1952940a19ce38d23 Mon Sep 17 00:00:00 2001 From: wolf Date: Mon, 28 Jan 2002 08:37:16 +0000 Subject: [PATCH] Add some documentation. git-svn-id: https://svn.dealii.org/trunk@5424 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/sparsity_pattern.h | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) 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; -- 2.39.5