Skip to content

Commit 9049a3c

Browse files
Merge pull request #123 from SciML/trustregiondocs
Add TrustRegion to the documentation
2 parents 8ae8f8a + 203426c commit 9049a3c

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

docs/src/api/nonlinearsolve.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ These are the native solvers of NonlinearSolve.jl.
66

77
```@docs
88
NewtonRaphson
9+
TrustRegion
910
```

docs/src/solvers/NonlinearSystemSolvers.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Solves for ``f(u)=0`` in the problem defined by `prob` using the algorithm
77

88
## Recommended Methods
99

10-
`NewtonRaphson` is a good choice for most problems. For large
10+
`TrustRegion` is a good choice for most problems. For large
1111
systems, it can make use of sparsity patterns for sparse automatic differentiation
1212
and sparse linear solving of very large systems. That said, as a classic Newton
1313
method, its stability region can be smaller than other methods. Meanwhile,
14-
`SimpleNewtonRaphson` and `TrustRegion` are implementations which are specialized for
14+
`SimpleNewtonRaphson` and `SimpleTrustRegion` are implementations which are specialized for
1515
small equations. It is non-allocating on static arrays and thus really well-optimized
1616
for small systems, thus usually outperforming the other methods when such types are
1717
used for `u0`. `DynamicSS` can be a good choice for high stability.
@@ -36,6 +36,8 @@ features, but have a bit of overhead on very small problems.
3636

3737
- `NewtonRaphson()`:A Newton-Raphson method with swappable nonlinear solvers and autodiff
3838
methods for high performance on large and sparse systems.
39+
- `TrustRegion()`: A Newton Trust Region dogleg method with swappable nonlinear solvers and
40+
autodiff methods for high performance on large and sparse systems.
3941

4042
### SimpleNonlinearSolve.jl
4143

@@ -48,7 +50,7 @@ methods excel at small problems and problems defined with static arrays.
4850
- `Klement()`: A quasi-Newton method due to Klement. It's supposed to be more efficient
4951
than Broyden's method, and it seems to be in the cases that have been tried but more
5052
benchmarking is required.
51-
- `TrustRegion()`: A dogleg trust-region Newton method. Improved globalizing stability
53+
- `SimpleTrustRegion()`: A dogleg trust-region Newton method. Improved globalizing stability
5254
for more robust fitting over basic Newton methods, though potentially with a cost.
5355

5456
!!! note

0 commit comments

Comments
 (0)