File tree 2 files changed +23
-1
lines changed
2 files changed +23
-1
lines changed Original file line number Diff line number Diff line change @@ -9,7 +9,13 @@ NewtonRaphson
9
9
TrustRegion
10
10
```
11
11
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
13
19
14
20
``` @docs
15
21
RadiusUpdateSchemes.Simple
Original file line number Diff line number Diff line change
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
+ """
1
17
EnumX. @enumx RadiusUpdateSchemes begin
2
18
"""
3
19
`RadiusUpdateSchemes.Simple`
You can’t perform that action at this time.
0 commit comments