]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Minor doc updates
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 27 Sep 2006 02:22:00 +0000 (02:22 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 27 Sep 2006 02:22:00 +0000 (02:22 +0000)
git-svn-id: https://svn.dealii.org/trunk@13966 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/lac/include/lac/lapack_full_matrix.h

index 4eb12002b27c303854e60965e1f6d1b34172af6b..945fe88b714d78ea1c53c99c0239cd89278bb6c1 100644 (file)
@@ -222,6 +222,25 @@ class LAPACKFullMatrix : public TransposeTable<number>
                                      * to compute left and right
                                      * eigenvectors as well.
                                      *
+                                     * Note that the function does
+                                     * not return the computed
+                                     * eigenvalues right away since
+                                     * that involves copying data
+                                     * around between the output
+                                     * arrays of the LAPACK functions
+                                     * and any return array. This is
+                                     * often unnecessary since one
+                                     * may not be interested in all
+                                     * eigenvalues at once, but for
+                                     * example only the extreme
+                                     * ones. In that case, it is
+                                     * cheaper to just have this
+                                     * function compute the
+                                     * eigenvalues and have a
+                                     * separate function that returns
+                                     * whatever eigenvalue is
+                                     * requested.
+                                     * 
                                      * @note Calls the LAPACK
                                      * function Xgeev.
                                      */
@@ -234,7 +253,7 @@ class LAPACKFullMatrix : public TransposeTable<number>
                                      * called.
                                      */
     std::complex<number>
-    eigenvalue (unsigned int i) const;
+    eigenvalue (const unsigned int i) const;
     
                                     /**
                                      * Print the matrix and allow
@@ -382,7 +401,7 @@ LAPACKFullMatrix<number>::fill (
 
 template <typename number>
 std::complex<number>
-LAPACKFullMatrix<number>::eigenvalue (unsigned int i) const
+LAPACKFullMatrix<number>::eigenvalue (const unsigned int i) const
 {
   Assert (state & LAPACKSupport::eigenvalues, ExcInvalidState());
   Assert (wr.size() == this->n_rows(), ExcInternalError());

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.