Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
yash-rs committed Aug 16, 2023
1 parent a9b9c7c commit 24fcd98
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/src/api/nonlinearsolve.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ NewtonRaphson
TrustRegion
```

### Radius Update Schemes for Trust Region (RadiusUpdateSchemes)
## Radius Update Schemes for Trust Region (RadiusUpdateSchemes)

```@docs
RadiusUpdateSchemes
```

### Available Radius Update Schemes

```@docs
RadiusUpdateSchemes.Simple
Expand Down
16 changes: 16 additions & 0 deletions src/trustRegion.jl
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
"""
`RadiusUpdateSchemes`
`RadiusUpdateSchemes` is the standard enum interface for different types of radius update schemes
implemented in the Trust Region method. These schemes specify how the radius of the so-called trust region
is updated after each iteration of the algorithm. The specific role and caveats associated with each
scheme are provided below.
## Using `RadiusUpdateSchemes`
`RadiusUpdateSchemes` uses the standard EnumX interface (https://github.com/fredrikekre/EnumX.jl),
and hence inherits all properties of being an EnumX, including the type of each constituent enum
states as `RadiusUpdateSchemes.T`. Simply put the desired scheme as follows:
`TrustRegion(radius_update_scheme = your desired update scheme)`. For example,
`sol = solve(prob, alg=TrustRegion(radius_update_scheme = RadiusUpdateSchemes.Hei))`.
"""
EnumX.@enumx RadiusUpdateSchemes begin
"""
`RadiusUpdateSchemes.Simple`
Expand Down

0 comments on commit 24fcd98

Please sign in to comment.