From: Wolfgang Bangerth Date: Mon, 5 Nov 2007 23:14:01 +0000 (+0000) Subject: Add to documentation. X-Git-Tag: v8.0.0~9646 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6643824f05bb80f01313fdcef739a9a3664230e8;p=dealii.git Add to documentation. git-svn-id: https://svn.dealii.org/trunk@15451 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/lac/include/lac/vector.h b/deal.II/lac/include/lac/vector.h index daaaa7ca8b..bdb2931f9b 100644 --- a/deal.II/lac/include/lac/vector.h +++ b/deal.II/lac/include/lac/vector.h @@ -72,7 +72,6 @@ class Vector : public Subscriptor * vector<...> class. */ typedef Number value_type; - typedef typename numbers::NumberTraits::real_type real_type; typedef value_type *pointer; typedef const value_type *const_pointer; typedef value_type *iterator; @@ -81,6 +80,26 @@ class Vector : public Subscriptor typedef const value_type &const_reference; typedef size_t size_type; + /** + * Declare a type that has holds + * real-valued numbers with the + * same precision as the template + * argument to this class. If the + * template argument of this + * class is a real data type, + * then real_type equals the + * template argument. If the + * template argument is a + * std::complex type then + * real_type equals the type + * underlying the complex + * numbers. + * + * This typedef is used to + * represent the return type of + * norms. + */ + typedef typename numbers::NumberTraits::real_type real_type; /** * @name 1: Basic Object-handling @@ -383,9 +402,14 @@ class Vector : public Subscriptor * computed depend on the order * of the arguments of this * vector. + * + * For complex vectors, the + * scalar product is implemented + * as $\left=\sum_i + * \bar{v_i} w_i$. */ template - Number operator* (const Vector &V) const; + Number operator * (const Vector &V) const; /** * Return square of the $l_2$-norm.