Skip to content

Commit

Permalink
Merge pull request #197 from yash2798/ys/tr_doctsrings
Browse files Browse the repository at this point in the history
Trust Region docstrings improvement
  • Loading branch information
ChrisRackauckas authored Jul 30, 2023
2 parents 25fbd71 + f76ba68 commit 7981d35
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/trustRegion.jl
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ for large-scale and numerically-difficult nonlinear systems.
preconditioners. For more information on specifying preconditioners for LinearSolve
algorithms, consult the
[LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
- `radius_update_scheme`: the choice of radius update scheme to be used. Defaults to `RadiusUpdateSchemes.Simple`
which follows the conventional approach. Other available schemes are `RadiusUpdateSchemes.Hei`,
`RadiusUpdateSchemes.Yuan`, `RadiusUpdateSchemes.Bastin`, `RadiusUpdateSchemes.Fan`. These schemes
have the trust region radius converging to zero that is seen to improve convergence. For more details, see the
[Yuan, Yx](https://link.springer.com/article/10.1007/s10107-015-0893-2#Sec4).
- `max_trust_radius`: the maximal trust region radius.
Defaults to `max(norm(fu), maximum(u) - minimum(u))`.
- `initial_trust_radius`: the initial trust region radius. Defaults to
Expand Down

0 comments on commit 7981d35

Please sign in to comment.