Skip to content

Commit

Permalink
Merge pull request #14954 from rossbar/doc/add-missing-minres-params
Browse files Browse the repository at this point in the history
DOC:sparse.linalg: Add missing params to minres docstring.
  • Loading branch information
ilayn committed Nov 2, 2021
2 parents 828a6c7 + a0ee70f commit 24ad852
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions scipy/sparse/linalg/isolve/minres.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ def minres(A, b, x0=None, shift=0.0, tol=1e-5, maxiter=None,
----------------
x0 : ndarray
Starting guess for the solution.
shift : float
Value to apply to the system ``(A - shift * I)x = b``. Default is 0.
tol : float
Tolerance to achieve. The algorithm terminates when the relative
residual is below `tol`.
Expand All @@ -55,6 +57,12 @@ def minres(A, b, x0=None, shift=0.0, tol=1e-5, maxiter=None,
callback : function
User-supplied function to call after each iteration. It is called
as callback(xk), where xk is the current solution vector.
show : bool
If ``True``, print out a summary and metrics related to the solution
during iterations. Default is ``False``.
check : bool
If ``True``, run additional input validation to check that `A` and
`M` (if specified) are symmetric. Default is ``False``.
Examples
--------
Expand Down

0 comments on commit 24ad852

Please sign in to comment.