From 4ef4da65a5301d7883654d65a2fa8cd783b0bc41 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Thu, 3 Sep 2015 21:32:31 -0400 Subject: [PATCH] update documentation --- include/deal.II/lac/sparsity_pattern.h | 30 ++++++++++++++------------ source/lac/sparsity_pattern.cc | 4 ++-- 2 files changed, 18 insertions(+), 16 deletions(-) diff --git a/include/deal.II/lac/sparsity_pattern.h b/include/deal.II/lac/sparsity_pattern.h index 5e26cc3718..daa6bbaf92 100644 --- a/include/deal.II/lac/sparsity_pattern.h +++ b/include/deal.II/lac/sparsity_pattern.h @@ -397,10 +397,11 @@ public: SparsityPattern (const SparsityPattern &); /** - * Initialize a rectangular matrix. + * Initialize a rectangular pattern of size m x n. * - * @arg m number of rows @arg n number of columns @arg max_per_row maximum - * number of nonzero entries per row + * @param[in] m The number of rows. + * @param[in] n The number of columns. + * @param[in] max_per_row Maximum number of nonzero entries per row. */ SparsityPattern (const size_type m, const size_type n, @@ -408,35 +409,36 @@ public: /** - * Initialize a rectangular matrix. + * Initialize a rectangular pattern of size m x n. * - * @arg m number of rows @arg n number of columns @arg row_lengths possible - * number of nonzero entries for each row. This vector must have one entry - * for each row. + * @param[in] m The number of rows. + * @param[in] n The number of columns. + * @param[in] row_lengths Possible number of nonzero entries for each row. This + * vector must have one entry for each row. */ SparsityPattern (const size_type m, const size_type n, const std::vector &row_lengths); /** - * Initialize a quadratic matrix of dimension n with at most + * Initialize a quadratic pattern of dimension m with at most * max_per_row nonzero entries per row. * * This constructor automatically enables optimized storage of diagonal * elements. To avoid this, use the constructor taking row and column * numbers separately. */ - SparsityPattern (const size_type n, + SparsityPattern (const size_type m, const unsigned int max_per_row); /** - * Initialize a quadratic matrix. + * Initialize a quadratic pattern of size m x m. * - * @arg m number of rows and columns @arg row_lengths possible number of - * nonzero entries for each row. This vector must have one entry for each - * row. + * @param[in] m The number of rows and columns. + * @param[in] row_lengths Maximum number of nonzero entries for each row. This + * vector must have one entry for each row. */ - SparsityPattern (const size_type m, + SparsityPattern (const size_type m, const std::vector &row_lengths); /** diff --git a/source/lac/sparsity_pattern.cc b/source/lac/sparsity_pattern.cc index 7b5d3f8c9e..ebac9b601e 100644 --- a/source/lac/sparsity_pattern.cc +++ b/source/lac/sparsity_pattern.cc @@ -103,7 +103,7 @@ SparsityPattern::SparsityPattern (const size_type m, -SparsityPattern::SparsityPattern (const size_type n, +SparsityPattern::SparsityPattern (const size_type m, const unsigned int max_per_row) : max_dim(0), @@ -111,7 +111,7 @@ SparsityPattern::SparsityPattern (const size_type n, rowstart(0), colnums(0) { - reinit (n, n, max_per_row); + reinit (m, m, max_per_row); } -- 2.39.5