From ae6e857036b1422887986e8f854c54531c6313c7 Mon Sep 17 00:00:00 2001 From: Guido Kanschat Date: Thu, 7 Apr 2005 21:09:10 +0000 Subject: [PATCH] documentation git-svn-id: https://svn.dealii.org/trunk@10417 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/lac/include/lac/householder.h | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/deal.II/lac/include/lac/householder.h b/deal.II/lac/include/lac/householder.h index 3d922d07f0..ae8af57b8a 100644 --- a/deal.II/lac/include/lac/householder.h +++ b/deal.II/lac/include/lac/householder.h @@ -31,6 +31,12 @@ template 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 x minimizing ||Ax-b|| for a given + * vector b. + * * @ref Instantiations: some (@ @) * * @author Guido Kanschat, 2005 @@ -49,9 +55,19 @@ class Householder : private FullMatrix /** * Solve the least-squares * problem for the right hand - * side src. The return + * side src. 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 b of the + * least squares problem. It will + * be changed uring the algorithm + * and is unusable on return. */ template double least_squares (Vector &dst, -- 2.39.5