updated README.md and attempted to augment test_jacobi.cpp to test fo…

…r convergence failure (in an effort to restore 100% code coverage again)
jewettaij · Nov 28, 2020 · e72d33b · e72d33b
1 parent a5a9352
commit e72d33b
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -74,13 +74,14 @@ Jacobi<double, double*, double**> eigen_calc(n);
 
 // Note:
 // If the matrix you plan to diagonalize (M) is read-only, use this instead:
-// Jacobi<double, double*, double**, double const*const*> eigen_calc(n);
-// If you prefer using vectors over C-style pointers, this works also:
-// Jacobi<double, vector<double>&, vector<vector<double>>&> eigen_calc(n);
+//   Jacobi<double, double*, double**, double const*const*> eigen_calc(n);
+// If you prefer using C++ vectors over C-style pointers, this works also:
+//   Jacobi<double, vector<double>&, vector<vector<double>>&,
+//          const vector<vector<Scalar>>&>  eigen_calc(n);
 
 // Now, calculate the eigenvalues and eigenvectors of M
 
-eigen_calc.Diagonalize(M, evals, evects);
+eigen_calc.Diagonalize(M, evals, evects);  //(succeeded if return value is != 0)
 ```
 
 ## Benchmarks

diff --git a/tests/test_jacobi.cpp b/tests/test_jacobi.cpp
@@ -539,6 +539,16 @@ void TestJacobi(int n, //<! matrix size
                                  Scalar*,
                                  Scalar**,
                                  Scalar const*const*>::SORT_INCREASING_ABS_EVALS);
+        // Also make sure the code considers a scenario where convergence fails:
+        ecalc.Diagonalize(M,
+                          evals,
+                          evecs,
+                          Jacobi<Scalar,
+                                 Scalar*,
+                                 Scalar**,
+                                 Scalar const*const*>::SORT_INCREASING_ABS_EVALS,
+                          true,
+                          0);   //<-- set the maximum allowed iterations to 0
         #endif
 
         for (int i = 1; i < n; i++)