]> https://gitweb.dealii.org/ - dealii.git/commitdiff
documentation
authorGuido Kanschat <dr.guido.kanschat@gmail.com>
Thu, 7 Apr 2005 21:09:10 +0000 (21:09 +0000)
committerGuido Kanschat <dr.guido.kanschat@gmail.com>
Thu, 7 Apr 2005 21:09:10 +0000 (21:09 +0000)
git-svn-id: https://svn.dealii.org/trunk@10417 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/householder.h

index 3d922d07f06b57e4037eb6f42523f85c09a069c4..ae8af57b8a8e98ab9f887d21d8b5b9b2e32c89ee 100644 (file)
@@ -31,6 +31,12 @@ template<typename number> class Vector;
 /**
  * QR-decomposition of a full matrix.
  *
+ * Whenever an object of this class is created, it copies the matrix
+ * given and computes its QR-decomposition by Householder
+ * algorithm. Then, the function least_squares() can be used to
+ * compute the vector <i>x</i> minimizing <i>||Ax-b||</i> for a given
+ * vector <i>b</i>.
+ *
  * @ref Instantiations: some (<tt>@<float@> @<double@></tt>)
  *
  * @author Guido Kanschat, 2005
@@ -49,9 +55,19 @@ class Householder : private FullMatrix<number>
                                     /**
                                      * Solve the least-squares
                                      * problem for the right hand
-                                     * side <tt>src</tt>.  The return
+                                     * side <tt>src</tt>. The return
                                      * value is the Euclidean norm of
                                      * the approximation error.
+                                     *
+                                     * @arg @c dst contains the
+                                     * solution of the least squares
+                                     * problem on return.
+                                     *
+                                     * @arg @c src contains the right
+                                     * hand side <i>b</i> of the
+                                     * least squares problem. It will
+                                     * be changed uring the algorithm
+                                     * and is unusable on return.
                                      */
     template<typename number2>
     double least_squares (Vector<number2> &dst,

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.