Merge pull request #75 from nidtec-una/74-prepare-for-third-release

KrySBAS v0.3.0
nidtec-una · Sep 11, 2024 · b5ed28c · b5ed28c
2 parents f9bb45e + fdc8022
commit b5ed28c
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 1 deletion.
diff --git a/src/gmres_e.m → src/solvers/gmres_e.m b/src/gmres_e.m → src/solvers/gmres_e.m
@@ -2,6 +2,9 @@
     gmres_e(A, b, m, d, tol, maxit, xInitial, eigstol, varargin)
     % GMRES-E algorithm
     %
+    %   Description:
+    %   ------------
+    %
     %   GMRES-E is a modified implementation of the restarted
     %   Generalized Minimal Residual Error or GMRES(m) [1], performed by
     %   appending 'd' eigenvectors corresponding to a few of the smallest

diff --git a/src/lgmres.m → src/solvers/lgmres.m b/src/lgmres.m → src/solvers/lgmres.m
@@ -2,6 +2,9 @@
     lgmres(A, b, m, l, tol, maxit, xInitial, varargin)
     % LGMRES algorithm
     %
+    %   Description:
+    %   ------------
+    %
     %   LGMRES ("Loose GMRES") is a modified implementation of the restarted
     %   Generalized Minimal Residual Error or GMRES(m) [1], performed by
     %   appending 'l' error approximation vectors to the restarting Krylov

diff --git a/src/pd_gmres.m → src/solvers/pd_gmres.m b/src/pd_gmres.m → src/solvers/pd_gmres.m
@@ -3,6 +3,9 @@
              varargin)
     % PD-GMRES Proportional-Derivative GMRES(m)
     %
+    %   Description:
+    %   ------------
+    %
     %   pd_gmres is a modified implementation of the restarted Generalized
     %   Minimal Residual Error or GMRES(m) [1], performed by using a
     %   proportional-derivative control-inspired law to update adaptively the

diff --git a/src/augmented_gram_schmidt_arnoldi.m → src/utils/augmented_gram_schmidt_arnoldi.m b/src/augmented_gram_schmidt_arnoldi.m → src/utils/augmented_gram_schmidt_arnoldi.m
diff --git a/src/harmonic_ritz_vectors.m → src/utils/harmonic_ritz_vectors.m b/src/harmonic_ritz_vectors.m → src/utils/harmonic_ritz_vectors.m
@@ -1,6 +1,9 @@
 function dy = harmonic_ritz_vectors(F, G, k, V, tol)
     % Harmonic Ritz Vectors function
     %
+    %   Description:
+    %   ------------
+    %
     %   This function is a modified implementation of the Rayleigh-Ritz method
     %   that finds good approximations to the smallest eigenvalues and its
     %   associated eigenvectors, and appends these ones to the next search

diff --git a/src/modified_gram_schmidt_arnoldi.m → src/utils/modified_gram_schmidt_arnoldi.m b/src/modified_gram_schmidt_arnoldi.m → src/utils/modified_gram_schmidt_arnoldi.m
diff --git a/src/pd_rule.m → src/utils/pd_rule.m b/src/pd_rule.m → src/utils/pd_rule.m
@@ -2,7 +2,7 @@
                          res, iter, alphaP, alphaD)
     % Rule for the Proportional-Derivative law. Algorithm 1 of [1].
     %
-    %   %   Signature:
+    %   Signature:
     %   ----------
     %
     %   miter = (m, n, mInitial, mMin, mMax, mStep,  ...

diff --git a/src/plane_rotations.m → src/utils/plane_rotations.m b/src/plane_rotations.m → src/utils/plane_rotations.m