From: Wolfgang Bangerth Date: Thu, 21 Dec 2017 20:13:00 +0000 (-0700) Subject: Fix the grammar of a few doc strings. X-Git-Tag: v9.0.0-rc1~628^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F5663%2Fhead;p=dealii.git Fix the grammar of a few doc strings. --- diff --git a/include/deal.II/lac/block_vector_base.h b/include/deal.II/lac/block_vector_base.h index c2e0c59da7..99a446afe6 100644 --- a/include/deal.II/lac/block_vector_base.h +++ b/include/deal.II/lac/block_vector_base.h @@ -780,7 +780,7 @@ public: value_type operator* (const BlockVectorBase &V) const; /** - * Return square of the $l_2$-norm. + * Return the square of the $l_2$-norm. */ real_type norm_sqr () const; diff --git a/include/deal.II/lac/la_parallel_block_vector.h b/include/deal.II/lac/la_parallel_block_vector.h index 1e61a3f0ff..2dd164b7a9 100644 --- a/include/deal.II/lac/la_parallel_block_vector.h +++ b/include/deal.II/lac/la_parallel_block_vector.h @@ -518,13 +518,13 @@ namespace LinearAlgebra virtual real_type l1_norm() const override; /** - * Return the l2 norm of the vector (i.e., the square root of + * Return the $l_2$ norm of the vector (i.e., the square root of * the sum of the square of all entries among all processors). */ virtual real_type l2_norm() const override; /** - * Return square of the l2 norm of the vector. + * Return the square of the $l_2$ norm of the vector. */ real_type norm_sqr() const; diff --git a/include/deal.II/lac/la_parallel_vector.h b/include/deal.II/lac/la_parallel_vector.h index 77d50c5d37..f10736a373 100644 --- a/include/deal.II/lac/la_parallel_vector.h +++ b/include/deal.II/lac/la_parallel_vector.h @@ -634,13 +634,13 @@ namespace LinearAlgebra virtual real_type l1_norm() const override; /** - * Return the l2 norm of the vector (i.e., the square root of + * Return the $l_2$ norm of the vector (i.e., the square root of * the sum of the square of all entries among all processors). */ virtual real_type l2_norm() const override; /** - * Return square of the l2 norm of the vector. + * Return the square of the $l_2$ norm of the vector. */ real_type norm_sqr() const; diff --git a/include/deal.II/lac/petsc_vector_base.h b/include/deal.II/lac/petsc_vector_base.h index 44441e634a..96209c8af2 100644 --- a/include/deal.II/lac/petsc_vector_base.h +++ b/include/deal.II/lac/petsc_vector_base.h @@ -497,7 +497,7 @@ namespace PETScWrappers PetscScalar operator * (const VectorBase &vec) const; /** - * Return square of the $l_2$-norm. + * Return the square of the $l_2$-norm. */ real_type norm_sqr () const; diff --git a/include/deal.II/lac/trilinos_vector.h b/include/deal.II/lac/trilinos_vector.h index bce5a4baa8..261e77833b 100644 --- a/include/deal.II/lac/trilinos_vector.h +++ b/include/deal.II/lac/trilinos_vector.h @@ -784,7 +784,7 @@ namespace TrilinosWrappers TrilinosScalar operator* (const Vector &vec) const; /** - * Return square of the $l_2$-norm. + * Return the square of the $l_2$-norm. */ real_type norm_sqr () const; diff --git a/include/deal.II/lac/vector.h b/include/deal.II/lac/vector.h index 23172d6067..7e712c095b 100644 --- a/include/deal.II/lac/vector.h +++ b/include/deal.II/lac/vector.h @@ -427,7 +427,7 @@ public: Number operator * (const Vector &V) const; /** - * Return square of the $l_2$-norm. + * Return the square of the $l_2$-norm. * * @dealiiOperationIsMultithreaded The algorithm uses pairwise summation * with the same order of summation in every run, which gives fully