]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc update.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 25 Mar 1999 14:59:25 +0000 (14:59 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 25 Mar 1999 14:59:25 +0000 (14:59 +0000)
git-svn-id: https://svn.dealii.org/trunk@1049 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/sparse_matrix.h

index 90517d7c2dbcd9852796aca0b1a14bce90460a6b..5e71572cad0371db5aea97b0748c46543186ebfd 100644 (file)
@@ -659,7 +659,14 @@ class SparseMatrix
                                      */
     number linfty_norm () const;
 
-                                    //
+                                    /**
+                                     * Compute the residual of an equation
+                                     * #Ax=b#, where the residual is defined
+                                     * to be #r=b-Ax# with #x# typically being
+                                     * an approximate of the true solution of
+                                     * the equation. Write the residual into
+                                     * #dst#.
+                                     */
     template <typename somenumber>
     double residual (Vector<somenumber>& dst, const Vector<somenumber>& x,
                     const Vector<somenumber>& b) const;

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.