Improve documentation of matrix dimensions.

diff --git a/include/deal.II/lac/block_matrix_base.h b/include/deal.II/lac/block_matrix_base.h
index 60ea3c462bf47e9f233d2ba47200b6696110aeb6..e1647c2e5818b0c4932158d05128b61ec6e36f3f 100644 (file)
--- 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 32124b6ca8fd571b00c4f0a912b13efe662a2d3d..e784ebc0f27af0e649e912a3df57317c19830369 100644 (file)
--- 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 a9b58f9e9f8c6a7061ebba83a34265fbf1dbab20..3238b340e4622977e779d03f326a8fa443dfe887 100644 (file)
--- 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 <i>n x
-   * n</i>-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 a4d259558545b79bfca3fd01df91e95a2d932078..7e7f985b3285007f63762e49d2e904de3da3431d 100644 (file)
--- 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<number> &) const;
 
   /**
-   * Number of rows of this matrix.  To remember: this matrix is an <i>m x
-   * n</i>-matrix.
+   * Number of rows of this matrix.  Note that the matrix is of dimension <i>m
+   * x n</i>.
    */
   size_type m () const;
 
   /**
-   * Number of columns of this matrix.  To remember: this matrix is an <i>m x
-   * n</i>-matrix.
+   * Number of columns of this matrix.  Note that the matrix is of dimension
+   * <i>m x n</i>.
    */
   size_type n () const;
 

diff --git a/include/deal.II/lac/precondition.h b/include/deal.II/lac/precondition.h
index 4117013862bfc1a55336447bac614041f2a0a7a4..c108edfafce6df2d7a4fec90dcca715ec69455ff 100644 (file)
--- 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 164018c81dec1dcd0ce0e6fa50012eb96880711b..2781a42419f6f3bd5134c5cbc0edba96f22ec0e2 100644 (file)
--- 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 77e0498785bbca149221c0f05ab8ff25687f2593..86f988fd1926020c9e56dc64a2915e03d354d47b 100644 (file)
--- 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 4efb441150d8ee14149f73ec7311001b90cb7491..2c26a307ef5f3c4ca3cefe166e95fa8a00585d3d 100644 (file)
--- a/include/deal.II/lac/sparse_direct.h
+++ b/include/deal.II/lac/sparse_direct.h
@@ -189,13 +189,13 @@ public:
                const BlockVector<double> &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 d171d39c39756dbb09bff9d3db824dc690809ea6..f2e59ffe7bd21063bb358c87ba8834b4fea270a5 100644 (file)
--- 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 8d45c0392e556989a5397ae69108cd6fdad5cee7..7a133edf98ad165840b5cc0175da3978cc04d648 100644 (file)
--- 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 a36dfea1bf675079dff53da6ee11633c418c915b..553bfec9a62e07d1ea559d85f24a4de29c0e2d30 100644 (file)
--- a/include/deal.II/lac/sparse_vanka.h
+++ b/include/deal.II/lac/sparse_vanka.h
@@ -240,7 +240,7 @@ public:
                const Vector<number2> &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 e928d5bc07b5010c8627a4758567e3841c989518..69a1a6ab24d3b00b96e4db67303369a687211125 100644 (file)
--- 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 <i>m x
-   * m</i>-matrix.
+   * Number of rows of this matrix. Note that the matrix is an <i>m x
+   * m</i> matrix.
    */
   size_type m () const;
 
   /**
-   * Number of columns of this matrix. To remember: this matrix is an <i>n x
-   * n</i>-matrix.
+   * Number of columns of this matrix. Note that the matrix is an <i>n x
+   * n</i> matrix.
    */
   size_type n () const;
 
@@ -398,4 +398,3 @@ TridiagonalMatrix<number>::print (
 DEAL_II_NAMESPACE_CLOSE
 
 #endif
-