]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Some doc fixed.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 7 Apr 2003 15:38:04 +0000 (15:38 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 7 Apr 2003 15:38:04 +0000 (15:38 +0000)
git-svn-id: https://svn.dealii.org/trunk@7361 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/sparse_matrix_ez.h
deal.II/lac/include/lac/sparse_matrix_ez.templates.h

index 3dcfcb4ccbf383bbe3e302c4da40eaf679829988..dd0d3335244041a42e8b892377221eeddc993a09 100644 (file)
@@ -358,6 +358,10 @@ class SparseMatrixEZ : public Subscriptor
                                      * properly is essential for an
                                      * efficient assembling of the
                                      * matrix.
+                                     *
+                                     * The default values are
+                                     * @p{default_row_length=5},
+                                     * @p{default_increment=4}.
                                      */
     explicit SparseMatrixEZ (const unsigned int n_rows,
                             const unsigned int n_columns,
@@ -390,6 +394,10 @@ class SparseMatrixEZ : public Subscriptor
                                      * properly is essential for an
                                      * efficient assembling of the
                                      * matrix.
+                                     *
+                                     * The default values are
+                                     * @p{default_row_length=5},
+                                     * @p{default_increment=4}.
                                      */
     void reinit (const unsigned int n_rows,
                 const unsigned int n_columns,
@@ -433,7 +441,7 @@ class SparseMatrixEZ : public Subscriptor
                                      * Set the element @p{(i,j)} to
                                      * @p{value}. Allocates the entry
                                      * if it does not exist. Filters
-                                     * out zero automatically.
+                                     * out zeroes automatically.
                                      */
     void set (const unsigned int i, const unsigned int j,
              const number value);
@@ -442,7 +450,7 @@ class SparseMatrixEZ : public Subscriptor
                                      * Add @p{value} to the element
                                      * @p{(i,j)}. Allocates the entry
                                      * if it does not exist. Filters
-                                     * out zero automatically.
+                                     * out zeroes automatically.
                                      */
     void add (const unsigned int i, const unsigned int j,
              const number value);
index ebfe02b78f017f81e45c5ffb0cdbe24fc994ac61..47c7750af0bf506180f8453b5886336d58901af1 100644 (file)
@@ -70,6 +70,13 @@ SparseMatrixEZ<number>::reinit(const unsigned int n_rows,
                               unsigned int default_increment)
 {
   clear();
+
+                                   // replace (invalid) default values
+                                   // by true defaults; note that
+                                   // these defaults are also
+                                   // documented in the docs of this
+                                   // function as well as in the docs
+                                   // of the constructor!
   if (default_row_length == Entry::invalid)
     default_row_length = 5;
   if (default_increment == Entry::invalid)

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.