]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
add documentation
authorkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 15 Sep 2006 14:45:52 +0000 (14:45 +0000)
committerkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 15 Sep 2006 14:45:52 +0000 (14:45 +0000)
git-svn-id: https://svn.dealii.org/trunk@13904 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/pointer_matrix.h

index ee51ed6ae4cfc03fe908e2ca9012e3471e48d327..7f2ad988accecb8b2ea01bbc5116a265057b5be9 100644 (file)
@@ -426,7 +426,14 @@ class PointerMatrixVector : public PointerMatrixBase<Vector<number> >
                                     /**
                                      * Matrix-vector product,
                                      * actually the scalar product of
-                                     * <tt>src</tt> and #m.
+                                     * <tt>src</tt> and the vector
+                                     * representing this matrix.
+                                     *
+                                     * The dimension of <tt>dst</tt>
+                                     * is 1, while that of
+                                     * <tt>src</tt> is the size of
+                                     * the vector representing this
+                                     * matrix.
                                      */
     virtual void vmult (Vector<number>& dst,
                        const Vector<number>& src) const;
@@ -434,8 +441,15 @@ class PointerMatrixVector : public PointerMatrixBase<Vector<number> >
                                     /**
                                      * Tranposed matrix-vector
                                      * product, actually the
-                                     * multiplication of #m with
+                                     * multiplication of the vector
+                                     * representing this matrix with
                                      * <tt>src(0)</tt>.
+                                     *
+                                     * The dimension of <tt>drc</tt>
+                                     * is 1, while that of
+                                     * <tt>dst</tt> is the size of
+                                     * the vector representing this
+                                     * matrix.
                                      */
     virtual void Tvmult (Vector<number>& dst,
                         const Vector<number>& src) const;
@@ -443,6 +457,12 @@ class PointerMatrixVector : public PointerMatrixBase<Vector<number> >
                                     /**
                                      * Matrix-vector product, adding to
                                      * <tt>dst</tt>.
+                                     *
+                                     * The dimension of <tt>dst</tt>
+                                     * is 1, while that of
+                                     * <tt>src</tt> is the size of
+                                     * the vector representing this
+                                     * matrix.
                                      */
     virtual void vmult_add (Vector<number>& dst,
                            const Vector<number>& src) const;
@@ -450,6 +470,12 @@ class PointerMatrixVector : public PointerMatrixBase<Vector<number> >
                                     /**
                                      * Tranposed matrix-vector product,
                                      * adding to <tt>dst</tt>.
+                                     *
+                                     * The dimension of <tt>src</tt>
+                                     * is 1, while that of
+                                     * <tt>dst</tt> is the size of
+                                     * the vector representing this
+                                     * matrix.
                                      */
     virtual void Tvmult_add (Vector<number>& dst,
                             const Vector<number>& src) 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.