Skip to content

Commit 8f88de1

Browse files
Merge pull request #143 from CCsimon123/master
Adding SimpleDFSane to docs
2 parents f2c334d + 56b7927 commit 8f88de1

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

docs/src/api/simplenonlinearsolve.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Falsi
1010
SimpleNewtonRaphson
1111
Broyden
1212
Klement
13-
TrustRegion
13+
SimpleTrustRegion
1414
Ridder
1515
Brent
16+
SimpleDFSane
1617
```

docs/src/solvers/NonlinearSystemSolvers.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ then `NLSolveJL`'s `:anderson` can be a good choice.
2323
## Full List of Methods
2424

2525
!!! note
26-
26+
2727
For the full details on the capabilities and constructors of the different solvers,
2828
see the Detailed Solver APIs section!
2929

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

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

5658
!!! note
57-
59+
5860
When used with certain types for the states `u` such as a `Number` or `StaticArray`,
5961
these solvers are very efficient and non-allocating. These implementations are thus
6062
well-suited for small systems of equations.

0 commit comments

Comments
 (0)