]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add to documentation.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 5 Nov 2007 23:14:01 +0000 (23:14 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 5 Nov 2007 23:14:01 +0000 (23:14 +0000)
git-svn-id: https://svn.dealii.org/trunk@15451 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/vector.h

index daaaa7ca8bbc2c480b8095ad7878c05d1395ed0e..bdb2931f9bdbfa235b99e82c5860e4116b7f2d1d 100644 (file)
@@ -72,7 +72,6 @@ class Vector : public Subscriptor
                                      * <tt>vector<...></tt> class.
                                      */
     typedef Number                                            value_type;
-    typedef typename numbers::NumberTraits<Number>::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<Number>::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<v,w\right>=\sum_i
+                                     * \bar{v_i} w_i$.
                                      */
     template <typename Number2>
-    Number operator* (const Vector<Number2> &V) const;
+    Number operator * (const Vector<Number2> &V) const;
 
                                     /**
                                      * Return square of the $l_2$-norm.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.