From ef412a1409fc42fa2840eb318ea4bef9913e4a8f Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Thu, 3 Sep 2015 23:57:08 -0500 Subject: [PATCH] Bugfixes: Update wrong descriptions, fix typos --- include/deal.II/base/tensor.h | 2 +- include/deal.II/base/tensor_base.h | 25 +++++++++++-------------- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index adf1df91e7..53c1314bca 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -160,7 +160,7 @@ operator * (const Tensor<0,dim,Number> &t, /** - * Division of a tensor of rank 0 with a scalar number. + * Division of a tensor of rank 0 by a scalar number. * * @relates Tensor<0,dim,Number> * @relates EnableIfScalar diff --git a/include/deal.II/base/tensor_base.h b/include/deal.II/base/tensor_base.h index 741b960096..9ec99e4123 100644 --- a/include/deal.II/base/tensor_base.h +++ b/include/deal.II/base/tensor_base.h @@ -247,18 +247,16 @@ public: void clear (); /** - * Return the Frobenius-norm of a tensor, i.e. the square root of the sum of - * squares of all entries. For the present case of rank-1 tensors, this - * equals the usual l2 norm of the vector. + * Return the Frobenius-norm of a tensor, i.e. the square root of the sum + * of the absolute squares of all entries. For the present case of rank-1 + * tensors, this equals the usual l2 norm of the + * vector. */ real_type norm () const; /** - * Return the square of the Frobenius-norm of a tensor, i.e. the square root - * of the sum of squares of all entries. - * - * This function mainly exists because it makes computing the norm simpler - * recursively, but may also be useful in other contexts. + * Return the square of the Frobenius-norm of a tensor, i.e. the sum of + * the absolute squares of all entries. */ real_type norm_square () const; @@ -535,17 +533,16 @@ public: void clear (); /** - * Return the Frobenius-norm of a tensor, i.e. the square root of the sum of - * squares of all entries. + * Return the Frobenius-norm of a tensor, i.e. the square root of the sum + * of the absolute squares of all entries. For the present case of rank-1 + * tensors, this equals the usual l2 norm of the + * vector. */ real_type norm () const; /** * Return the square of the Frobenius-norm of a tensor, i.e. the sum of - * squares of all entries. - * - * This function mainly exists because it makes computing the norm simpler - * recursively, but may also be useful in other contexts. + * the absolute squares of all entries. */ real_type norm_square () const; -- 2.39.5