Skip to content

Commit

Permalink
Run formatter
Browse files Browse the repository at this point in the history
  • Loading branch information
avik-pal committed Jan 16, 2024
1 parent 3db75f0 commit ca15839
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions docs/src/basics/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,12 +138,17 @@ computation and the type of this chunksize can't be statically inferred. To fix
directly specify the chunksize:

```@example type_unstable
@code_warntype solve(prob, NewtonRaphson(;
autodiff = AutoForwardDiff(; chunksize = NonlinearSolve.pickchunksize(prob.u0))))
@code_warntype solve(prob,
NewtonRaphson(;
autodiff = AutoForwardDiff(; chunksize = NonlinearSolve.pickchunksize(prob.u0))))
nothing # hide
```

And boom! Type stable again. We always recommend picking the chunksize via
[`NonlinearSolve.pickchunksize`](@ref), however, if you manually specify the chunksize, it
must be `≤ length of input`. However, a very large chunksize can lead to excessive
compilation times and slowdown.

```@docs
NonlinearSolve.pickchunksize
```
2 changes: 1 addition & 1 deletion docs/src/native/simplenonlinearsolve.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ These methods are suited for any general nonlinear root-finding problem, i.e.
|:------------------------------------ |:-------- |:------------ |:------------------------ |:------------------------- |
| [`SimpleNewtonRaphson`](@ref) | ✔️ | ✔️ | ✔️ | ✔️ |
| [`SimpleBroyden`](@ref) | ✔️ | ✔️ | ✔️ | ✔️ |
| [`SimpleHalley`](@ref) || ✔️ | ✔️ ||
| [`SimpleHalley`](@ref) | | ✔️ | ✔️ ||
| [`SimpleKlement`](@ref) | ✔️ | ✔️ | ✔️ | ✔️ |
| [`SimpleTrustRegion`](@ref) | ✔️ | ✔️ | ✔️ | ✔️ |
| [`SimpleDFSane`](@ref) | ✔️ | ✔️ | ✔️[^1] | ✔️ |
Expand Down

0 comments on commit ca15839

Please sign in to comment.