Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding SimpleDFSane to docs #143

Merged
merged 1 commit into from
Feb 7, 2023
+7 −4
Merged

Adding SimpleDFSane to docs #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/src/api/simplenonlinearsolve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Falsi
SimpleNewtonRaphson
Broyden
Klement
TrustRegion
SimpleTrustRegion
Ridder
Brent
SimpleDFSane
```
8 changes: 5 additions & 3 deletions docs/src/solvers/NonlinearSystemSolvers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ then `NLSolveJL`'s `:anderson` can be a good choice.
## Full List of Methods

!!! note

For the full details on the capabilities and constructors of the different solvers,
see the Detailed Solver APIs section!

Expand All @@ -46,15 +46,17 @@ can be used directly to reduce dependencies and improve load times. SimpleNonlin
methods excel at small problems and problems defined with static arrays.

- `SimpleNewtonRaphson()`: A simplified implementation of the Newton-Raphson method.
- `Broyden()`: the classic Broyden's quasi-Newton method.
- `Broyden()`: The classic Broyden's quasi-Newton method.
- `Klement()`: A quasi-Newton method due to Klement. It's supposed to be more efficient
than Broyden's method, and it seems to be in the cases that have been tried, but more
benchmarking is required.
- `SimpleTrustRegion()`: A dogleg trust-region Newton method. Improved globalizing stability
for more robust fitting over basic Newton methods, though potentially with a cost.
- `SimpleDFSane()`: A low-overhead implementation of the df-sane method for solving
large-scale nonlinear systems of equations.

!!! note

When used with certain types for the states `u` such as a `Number` or `StaticArray`,
these solvers are very efficient and non-allocating. These implementations are thus
well-suited for small systems of equations.
Expand Down