Merge pull request #638 from IruNikZe/dev

Added missing `iiter` and `xnorm` to the documentation of `pylops.lsqr`
PyLops · Feb 2, 2025 · 81b6ff9 · 81b6ff9
2 parents b35bbaf + 51f1b7f
commit 81b6ff9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/pylops/optimization/basic.py b/pylops/optimization/basic.py
@@ -242,6 +242,8 @@ def lsqr(
 
         ``7`` means the iteration limit has been reached
 
+    iiter : :obj:`int`
+        Iteration number upon termination
     r1norm : :obj:`float`
         :math:`||\mathbf{r}||_2^2`, where
         :math:`\mathbf{r} = \mathbf{y} - \mathbf{Op}\,\mathbf{x}`
@@ -257,6 +259,8 @@ def lsqr(
     arnorm : :obj:`float`
         Estimate of norm of :math:`\cond(\mathbf{Op}^H\mathbf{r}-
         \epsilon^2\mathbf{x})`
+    xnorm : :obj:`float`
+        :math:`||\mathbf{x}||_2`
     var : :obj:`float`
         Diagonals of :math:`(\mathbf{Op}^H\mathbf{Op})^{-1}` (if ``damp=0``)
         or more generally :math:`(\mathbf{Op}^H\mathbf{Op} +

diff --git a/pylops/optimization/cls_basic.py b/pylops/optimization/cls_basic.py
@@ -1043,6 +1043,8 @@ def solve(
 
             ``7`` means the iteration limit has been reached
 
+        iiter : :obj:`int`
+            Iteration number upon termination
         r1norm : :obj:`float`
             :math:`||\mathbf{r}||_2^2`, where
             :math:`\mathbf{r} = \mathbf{y} - \mathbf{Op}\,\mathbf{x}`
@@ -1058,6 +1060,8 @@ def solve(
         arnorm : :obj:`float`
             Estimate of norm of :math:`\cond(\mathbf{Op}^H\mathbf{r}-
             \epsilon^2\mathbf{x})`
+        xnorm : :obj:`float`
+            :math:`||\mathbf{x}||_2`
         var : :obj:`float`
             Diagonals of :math:`(\mathbf{Op}^H\mathbf{Op})^{-1}` (if ``damp=0``)
             or more generally :math:`(\mathbf{Op}^H\mathbf{Op} +