Skip to content

Commit 24fcd98

Browse files
committed
fixes
1 parent a9b9c7c commit 24fcd98

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

Diff for: docs/src/api/nonlinearsolve.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,13 @@ NewtonRaphson
99
TrustRegion
1010
```
1111

12-
### Radius Update Schemes for Trust Region (RadiusUpdateSchemes)
12+
## Radius Update Schemes for Trust Region (RadiusUpdateSchemes)
13+
14+
```@docs
15+
RadiusUpdateSchemes
16+
```
17+
18+
### Available Radius Update Schemes
1319

1420
```@docs
1521
RadiusUpdateSchemes.Simple

Diff for: src/trustRegion.jl

+16
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
"""
2+
`RadiusUpdateSchemes`
3+
4+
`RadiusUpdateSchemes` is the standard enum interface for different types of radius update schemes
5+
implemented in the Trust Region method. These schemes specify how the radius of the so-called trust region
6+
is updated after each iteration of the algorithm. The specific role and caveats associated with each
7+
scheme are provided below.
8+
9+
## Using `RadiusUpdateSchemes`
10+
11+
`RadiusUpdateSchemes` uses the standard EnumX interface (https://github.com/fredrikekre/EnumX.jl),
12+
and hence inherits all properties of being an EnumX, including the type of each constituent enum
13+
states as `RadiusUpdateSchemes.T`. Simply put the desired scheme as follows:
14+
`TrustRegion(radius_update_scheme = your desired update scheme)`. For example,
15+
`sol = solve(prob, alg=TrustRegion(radius_update_scheme = RadiusUpdateSchemes.Hei))`.
16+
"""
117
EnumX.@enumx RadiusUpdateSchemes begin
218
"""
319
`RadiusUpdateSchemes.Simple`

0 commit comments

Comments
 (0)