From 2db0688995602a45ae67d742e3585968735b4280 Mon Sep 17 00:00:00 2001 From: Daniel Arndt Date: Wed, 20 Feb 2019 11:38:19 +0100 Subject: [PATCH] Improve QR documentation --- include/deal.II/lac/qr.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/include/deal.II/lac/qr.h b/include/deal.II/lac/qr.h index 1898d6fb14..7625f79357 100644 --- a/include/deal.II/lac/qr.h +++ b/include/deal.II/lac/qr.h @@ -127,8 +127,8 @@ public: * Connect a slot to retrieve a notification when the Givens rotations * are performed. * - * The function takes @p i'th and @p j'th indices of the plane of rotation - * and a triplet of numbers @p csr (cosine, sine and radius, see + * The function takes two indices, @p i and @p j, describing the plane of + * rotation, and a triplet of numbers @p csr (cosine, sine and radius, see * Utilities::LinearAlgebra::givens_rotation()) which represents the rotation * matrix. */ @@ -169,7 +169,7 @@ protected: /** * Signal used to retrieve a notification - * when Givens rotations are performed in plane @p i and @p j. + * when Givens rotations are performed in the `(i,j)`-plane. */ boost::signals2::signaltrue. */ @@ -310,7 +310,7 @@ public: private: /** - * Apply givens rotation in plane @p i @p k to @p Q and @p R so that + * Apply givens rotation in the `(i,j)`-plane to @p Q and @p R so that * R(k,k) is zeroed. * * See Chapter 5.1.9 of Golub 2013, Matrix computations. @@ -396,7 +396,7 @@ public: * Connect a slot to implement a custom check of linear dependency * during addition of a column. * - * Here, @p u is the last column of the to-be R matrix , @p rho + * Here, @p u is the last column of the to-be R matrix, @p rho * is its diagonal and @p col_norm_sqr is the square of the $l2$ norm of the column. * The function should return true if the new column is * linearly independent. @@ -409,7 +409,7 @@ public: private: /** - * Apply givens rotation in plane @i @p k to zero out $R(k,k)$. + * Apply givens rotation in the `(i,k)`-plane to zero out $R(k,k)$. */ void apply_givens_rotation(const unsigned int i, const unsigned int k); @@ -417,7 +417,7 @@ private: /** * Signal used to decide if the new column is linear dependent. * - * Here, @p u is the last column of the to-be R matrix , @p rho + * Here, @p u is the last column of the to-be R matrix, @p rho * is its diagonal and @p col_norm_sqr is the square of the $l2$ norm of the column. * The function should return true if the new column is * linearly independent. -- 2.39.5