Skip to content

Commit 4c0f628

Browse files
committed
Add in documentation
1 parent c6992a5 commit 4c0f628

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

docs/pages.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ pages = ["index.md",
1717
"Solver Summaries and Recommendations" => Any["solvers/NonlinearSystemSolvers.md",
1818
"solvers/BracketingSolvers.md",
1919
"solvers/SteadyStateSolvers.md",
20-
"solvers/NonlinearLeastSquaresSolvers.md"],
20+
"solvers/NonlinearLeastSquaresSolvers.md",
21+
"solvers/LineSearch.md"],
2122
"Detailed Solver APIs" => Any["api/nonlinearsolve.md",
2223
"api/simplenonlinearsolve.md",
2324
"api/minpack.md",

docs/src/solvers/LineSearch.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# [Line Search](@id linesearch)
2+
3+
A convenience wrapper over `LineSearches.jl` and some native Line Search methods, powered
4+
internally with fast automatic differentiation.
5+
6+
```@docs
7+
LineSearch
8+
```
9+
10+
## Native Line Search Methods
11+
12+
```@docs
13+
LiFukushimaLineSearch
14+
```

docs/src/solvers/NonlinearSystemSolvers.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ features, but have a bit of overhead on very small problems.
6565
- `FastShortcutNonlinearPolyalg()`: The default method. A polyalgorithm that mixes fast methods
6666
with fallbacks to robust methods to allow for solving easy problems quickly without sacrificing
6767
robustnes on the hard problems.
68+
- `GeneralBroyden()`: Generalization of Broyden's Quasi-Newton Method with Line Search and
69+
Automatic Jacobian Resetting. This is a fast method but unstable for most problems!
6870

6971
### SimpleNonlinearSolve.jl
7072

0 commit comments

Comments
 (0)