]> https://gitweb.dealii.org/ - dealii.git/commitdiff
add more documentation to the compute_svd function.
authorMenno Fraters <menno.fraters@outlook.com>
Thu, 12 Sep 2019 02:25:12 +0000 (19:25 -0700)
committerMenno Fraters <menno.fraters@outlook.com>
Thu, 12 Sep 2019 15:44:29 +0000 (08:44 -0700)
include/deal.II/lac/lapack_full_matrix.h

index 2c3cef64fe1ea234f81088e30feaac99c9ec855a..4bc395cabc6ef861dddce5d31c4844e7d983e5ae 100644 (file)
@@ -815,7 +815,17 @@ public:
    *
    * Requires that the #state is LAPACKSupport::matrix, fills the data members
    * #wr, #svd_u, and #svd_vt, and leaves the object in the #state
-   * LAPACKSupport::svd.
+   * LAPACKSupport::svd. 
+   * 
+   * The singular value decomposition factorizes the provided matrix (A) into 
+   * three parts U, sigma and the transpose of V (V^T), such that A = U sigma 
+   * V^T. Sigma is a MxN matrix which contains the singular values of A on 
+   * the diagonal while all the other elements are zero. U is a MxM orthogonal 
+   * matrix containing the left singular vectors corresponding to the singular
+   * values of A. V is a NxN orthonal matrix containing the right singular 
+   * vectors corresponding the the singular values of A.
+   *  
+   * Note that the variable #svd_vt contains the tranposed of V.  
    */
   void
   compute_svd();

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.