Skip to content

Commit

Permalink
remove annotations and variants minres!, add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffroyleconte committed Apr 9, 2021
1 parent d2dd1dc commit edf0608
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/minres.jl
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,17 @@ assumed to be symmetric and positive definite.
It is also possible to use MINRES in-place
(x, stats) = minres!(solver :: MinresSolver{S, T}, opA, b :: AbstractVector{T};
(x, stats) = minres!(solver :: MinresSolver{S, T}, A, b :: AbstractVector{T};
M=opEye(), λ :: T=zero(T), atol :: T=√eps(T)/100,
rtol :: T=√eps(T)/100, ratol :: T=zero(T),
rrtol :: T=zero(T), etol :: T=√eps(T),
itmax :: Int=0, conlim :: T=1/√eps(T),
verbose :: Int=0) where {S, T <: AbstractFloat}
where `solver` is a [`Krylov.MinresSolver`](@ref) used to store the vectors used by `minres!`.
In this case, the user should be aware that A should be a
[PreallocatedLinearOperator](https://juliasmoothoptimizers.github.io/LinearOperators.jl/latest/reference/#LinearOperators.PreallocatedLinearOperator),
otherwise there is no guarantee that there will be no allocations.
#### Reference
* C. C. Paige and M. A. Saunders, *Solution of Sparse Indefinite Systems of Linear Equations*, SIAM Journal on Numerical Analysis, 12(4), pp. 617--629, 1975.
Expand Down

0 comments on commit edf0608

Please sign in to comment.