]> https://gitweb.dealii.org/ - dealii.git/commitdiff
documentation fixes 767/head
authorMatthias Maier <tamiko@43-1.org>
Sat, 11 Apr 2015 09:24:50 +0000 (11:24 +0200)
committerMatthias Maier <tamiko@43-1.org>
Sat, 11 Apr 2015 09:25:17 +0000 (11:25 +0200)
include/deal.II/lac/full_matrix.templates.h
include/deal.II/lac/lapack_full_matrix.h

index 03b4609358945e2d445373f62f84b7ecd1ef1f0c..1b7c9c0c3edbe96312fe16ac3a19f7f868814d7e 100644 (file)
@@ -22,6 +22,7 @@
 // file and in each case pick the more accurate data type for intermediate
 // results. currently, the choice is pretty much random. this may also allow
 // us some operations where one operand is complex and the other is not
+// -> use ProductType<T,U> type trait for the results
 
 #include <deal.II/base/config.h>
 #include <deal.II/base/template_constraints.h>
index b9a90ae9880e65b6192a74cadadac21f809a5b62..107a03a8efb7acdbe9c3e50e1e09d112d0ff50ac 100644 (file)
@@ -208,13 +208,16 @@ public:
    * @note The template with @tref number2 only exists for compile-time
    * compatibility with FullMatrix. Only the case @tref number2 = @tref
    * number is implemented due to limitations in the underlying LAPACK
-   * interface
+   * interface. All other variants throw an error upon invocation.
    */
   template <typename number2>
   void vmult (Vector<number2>       &w,
               const Vector<number2> &v,
               const bool             adding = false) const;
 
+  /**
+   * Specialization of above function for compatbile Vector::value_type.
+   */
   void vmult (Vector<number>       &w,
               const Vector<number> &v,
               const bool            adding = false) const;
@@ -228,6 +231,9 @@ public:
   void vmult_add (Vector<number2>       &w,
                   const Vector<number2> &v) const;
 
+  /**
+   * Specialization of above function for compatbile Vector::value_type.
+   */
   void vmult_add (Vector<number>       &w,
                   const Vector<number> &v) const;
 
@@ -248,6 +254,9 @@ public:
                const Vector<number2> &v,
                const bool             adding=false) const;
 
+  /**
+   * Specialization of above function for compatbile Vector::value_type.
+   */
   void Tvmult (Vector<number>       &w,
                const Vector<number> &v,
                const bool            adding=false) const;
@@ -262,6 +271,9 @@ public:
   void Tvmult_add (Vector<number2>       &w,
                    const Vector<number2> &v) const;
 
+  /**
+   * Specialization of above function for compatbile Vector::value_type.
+   */
   void Tvmult_add (Vector<number>       &w,
                    const Vector<number> &v) const;
 

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.