From 622bc560f183090aef7d035965a2badd77d5825a Mon Sep 17 00:00:00 2001 From: Martin Kronbichler Date: Mon, 31 Oct 2016 07:54:45 +0100 Subject: [PATCH] Improve documentation of matrix dimensions. --- include/deal.II/lac/block_matrix_base.h | 4 ++-- include/deal.II/lac/chunk_sparse_matrix.h | 4 ++-- include/deal.II/lac/diagonal_matrix.h | 4 ++-- include/deal.II/lac/full_matrix.h | 8 ++++---- include/deal.II/lac/precondition.h | 16 ++++++++-------- include/deal.II/lac/precondition_selector.h | 4 ++-- include/deal.II/lac/sparse_decomposition.h | 4 ++-- include/deal.II/lac/sparse_direct.h | 4 ++-- include/deal.II/lac/sparse_matrix.h | 4 ++-- include/deal.II/lac/sparse_matrix_ez.h | 4 ++-- include/deal.II/lac/sparse_vanka.h | 4 ++-- include/deal.II/lac/tridiagonal_matrix.h | 9 ++++----- 12 files changed, 34 insertions(+), 35 deletions(-) diff --git a/include/deal.II/lac/block_matrix_base.h b/include/deal.II/lac/block_matrix_base.h index 60ea3c462b..e1647c2e58 100644 --- a/include/deal.II/lac/block_matrix_base.h +++ b/include/deal.II/lac/block_matrix_base.h @@ -413,13 +413,13 @@ public: const unsigned int column) const; /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/chunk_sparse_matrix.h b/include/deal.II/lac/chunk_sparse_matrix.h index 32124b6ca8..e784ebc0f2 100644 --- a/include/deal.II/lac/chunk_sparse_matrix.h +++ b/include/deal.II/lac/chunk_sparse_matrix.h @@ -579,13 +579,13 @@ public: bool empty () const; /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/diagonal_matrix.h b/include/deal.II/lac/diagonal_matrix.h index a9b58f9e9f..3238b340e4 100644 --- a/include/deal.II/lac/diagonal_matrix.h +++ b/include/deal.II/lac/diagonal_matrix.h @@ -65,8 +65,8 @@ public: size_type m () const; /** - * Number of columns of this matrix. To remember: this matrix is an n x - * n-matrix. + * Number of columns of this matrix. This number corresponds to the size of + * the underlying vector. */ size_type n () const; diff --git a/include/deal.II/lac/full_matrix.h b/include/deal.II/lac/full_matrix.h index a4d2595585..7e7f985b32 100644 --- a/include/deal.II/lac/full_matrix.h +++ b/include/deal.II/lac/full_matrix.h @@ -464,14 +464,14 @@ public: bool operator == (const FullMatrix &) const; /** - * Number of rows of this matrix. To remember: this matrix is an m x - * n-matrix. + * Number of rows of this matrix. Note that the matrix is of dimension m + * x n. */ size_type m () const; /** - * Number of columns of this matrix. To remember: this matrix is an m x - * n-matrix. + * Number of columns of this matrix. Note that the matrix is of dimension + * m x n. */ size_type n () const; diff --git a/include/deal.II/lac/precondition.h b/include/deal.II/lac/precondition.h index 4117013862..c108edfafc 100644 --- a/include/deal.II/lac/precondition.h +++ b/include/deal.II/lac/precondition.h @@ -136,7 +136,7 @@ public: void clear () {} /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. * * @note This function should only be called if the preconditioner has been @@ -145,7 +145,7 @@ public: size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. * * @note This function should only be called if the preconditioner has been @@ -258,7 +258,7 @@ public: void clear () {} /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. * * @note This function should only be called if the preconditioner has been @@ -267,7 +267,7 @@ public: size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. * * @note This function should only be called if the preconditioner has been @@ -420,13 +420,13 @@ public: void clear(); /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; @@ -1024,13 +1024,13 @@ public: void clear (); /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/precondition_selector.h b/include/deal.II/lac/precondition_selector.h index 164018c81d..2781a42419 100644 --- a/include/deal.II/lac/precondition_selector.h +++ b/include/deal.II/lac/precondition_selector.h @@ -119,13 +119,13 @@ public: void use_matrix(const MatrixType &M); /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/sparse_decomposition.h b/include/deal.II/lac/sparse_decomposition.h index 77e0498785..86f988fd19 100644 --- a/include/deal.II/lac/sparse_decomposition.h +++ b/include/deal.II/lac/sparse_decomposition.h @@ -220,14 +220,14 @@ public: /** * Return the dimension of the codomain (or range) space. It calls the - * inherited SparseMatrix::m() function. To remember: the matrix is of + * inherited SparseMatrix::m() function. Note that the matrix is of * dimension $m \times n$. */ size_type m () const; /** * Return the dimension of the domain space. It calls the inherited - * SparseMatrix::n() function. To remember: the matrix is of dimension $m + * SparseMatrix::n() function. Note that the matrix is of dimension $m * \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/sparse_direct.h b/include/deal.II/lac/sparse_direct.h index 4efb441150..2c26a307ef 100644 --- a/include/deal.II/lac/sparse_direct.h +++ b/include/deal.II/lac/sparse_direct.h @@ -189,13 +189,13 @@ public: const BlockVector &src) const; /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/sparse_matrix.h b/include/deal.II/lac/sparse_matrix.h index d171d39c39..f2e59ffe7b 100644 --- a/include/deal.II/lac/sparse_matrix.h +++ b/include/deal.II/lac/sparse_matrix.h @@ -664,13 +664,13 @@ public: bool empty () const; /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/sparse_matrix_ez.h b/include/deal.II/lac/sparse_matrix_ez.h index 8d45c0392e..7a133edf98 100644 --- a/include/deal.II/lac/sparse_matrix_ez.h +++ b/include/deal.II/lac/sparse_matrix_ez.h @@ -374,13 +374,13 @@ public: bool empty () const; /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. */ size_type n () const; diff --git a/include/deal.II/lac/sparse_vanka.h b/include/deal.II/lac/sparse_vanka.h index a36dfea1bf..553bfec9a6 100644 --- a/include/deal.II/lac/sparse_vanka.h +++ b/include/deal.II/lac/sparse_vanka.h @@ -240,7 +240,7 @@ public: const Vector &src) const; /** - * Return the dimension of the codomain (or range) space. To remember: the + * Return the dimension of the codomain (or range) space. Note that the * matrix is of dimension $m \times n$. * * @note This function should only be called if the preconditioner has been @@ -249,7 +249,7 @@ public: size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is of + * Return the dimension of the domain space. Note that the matrix is of * dimension $m \times n$. * * @note This function should only be called if the preconditioner has been diff --git a/include/deal.II/lac/tridiagonal_matrix.h b/include/deal.II/lac/tridiagonal_matrix.h index e928d5bc07..69a1a6ab24 100644 --- a/include/deal.II/lac/tridiagonal_matrix.h +++ b/include/deal.II/lac/tridiagonal_matrix.h @@ -78,14 +78,14 @@ public: //@{ /** - * Number of rows of this matrix. To remember: this matrix is an m x - * m-matrix. + * Number of rows of this matrix. Note that the matrix is an m x + * m matrix. */ size_type m () const; /** - * Number of columns of this matrix. To remember: this matrix is an n x - * n-matrix. + * Number of columns of this matrix. Note that the matrix is an n x + * n matrix. */ size_type n () const; @@ -398,4 +398,3 @@ TridiagonalMatrix::print ( DEAL_II_NAMESPACE_CLOSE #endif - -- 2.39.5