From 24fcd98dfe5a4b0283a4b9899ea25710a64c32ae Mon Sep 17 00:00:00 2001 From: Yash Raj Singh Date: Thu, 17 Aug 2023 01:53:53 +0200 Subject: [PATCH] fixes --- docs/src/api/nonlinearsolve.md | 8 +++++++- src/trustRegion.jl | 16 ++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/src/api/nonlinearsolve.md b/docs/src/api/nonlinearsolve.md index a8d3a6f2c..ff61c4813 100644 --- a/docs/src/api/nonlinearsolve.md +++ b/docs/src/api/nonlinearsolve.md @@ -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 diff --git a/src/trustRegion.jl b/src/trustRegion.jl index 026d49219..d070bdfc8 100644 --- a/src/trustRegion.jl +++ b/src/trustRegion.jl @@ -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`