Skip to content

Commit 51f1b7f

Browse files
committed
DOC:
**Issue [Documentation] `pylops.lsqr` documentation lists 9 results even though there is 11 #637** - added `iiter` and `xnorm` to the documentation of the `pylops.lsqr` solver and related methods
1 parent b35bbaf commit 51f1b7f

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

pylops/optimization/basic.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,8 @@ def lsqr(
242242
243243
``7`` means the iteration limit has been reached
244244
245+
iiter : :obj:`int`
246+
Iteration number upon termination
245247
r1norm : :obj:`float`
246248
:math:`||\mathbf{r}||_2^2`, where
247249
:math:`\mathbf{r} = \mathbf{y} - \mathbf{Op}\,\mathbf{x}`
@@ -257,6 +259,8 @@ def lsqr(
257259
arnorm : :obj:`float`
258260
Estimate of norm of :math:`\cond(\mathbf{Op}^H\mathbf{r}-
259261
\epsilon^2\mathbf{x})`
262+
xnorm : :obj:`float`
263+
:math:`||\mathbf{x}||_2`
260264
var : :obj:`float`
261265
Diagonals of :math:`(\mathbf{Op}^H\mathbf{Op})^{-1}` (if ``damp=0``)
262266
or more generally :math:`(\mathbf{Op}^H\mathbf{Op} +

pylops/optimization/cls_basic.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1043,6 +1043,8 @@ def solve(
10431043
10441044
``7`` means the iteration limit has been reached
10451045
1046+
iiter : :obj:`int`
1047+
Iteration number upon termination
10461048
r1norm : :obj:`float`
10471049
:math:`||\mathbf{r}||_2^2`, where
10481050
:math:`\mathbf{r} = \mathbf{y} - \mathbf{Op}\,\mathbf{x}`
@@ -1058,6 +1060,8 @@ def solve(
10581060
arnorm : :obj:`float`
10591061
Estimate of norm of :math:`\cond(\mathbf{Op}^H\mathbf{r}-
10601062
\epsilon^2\mathbf{x})`
1063+
xnorm : :obj:`float`
1064+
:math:`||\mathbf{x}||_2`
10611065
var : :obj:`float`
10621066
Diagonals of :math:`(\mathbf{Op}^H\mathbf{Op})^{-1}` (if ``damp=0``)
10631067
or more generally :math:`(\mathbf{Op}^H\mathbf{Op} +

0 commit comments

Comments
 (0)