Skip to content

Commit aad2f3e

Browse files
committed
radius_update_scheme docstring
1 parent 2b6f1c6 commit aad2f3e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/trustRegion.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ for large-scale and numerically-difficult nonlinear systems.
5050
preconditioners. For more information on specifying preconditioners for LinearSolve
5151
algorithms, consult the
5252
[LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
53-
- `radius_update_scheme`: the choice of radius update scheme to be used. Defaults to RadiusUpdateSchemes.Simple
54-
which follows the conventional approach
53+
- `radius_update_scheme`: the choice of radius update scheme to be used. Defaults to `RadiusUpdateSchemes.Simple`
54+
which follows the conventional approach. Other available schemes are `RadiusUpdateSchemes.Hei`,
55+
`RadiusUpdateSchemes.Yuan`, `RadiusUpdateSchemes.Bastin`, `RadiusUpdateSchemes.Fan`. For more details, see the
56+
tutorials and [Yuan, Yx](https://link.springer.com/article/10.1007/s10107-015-0893-2#Sec4).
5557
- `max_trust_radius`: the maximal trust region radius.
5658
Defaults to `max(norm(fu), maximum(u) - minimum(u))`.
5759
- `initial_trust_radius`: the initial trust region radius. Defaults to

0 commit comments

Comments
 (0)