Skip to content

Commit

Permalink
Add a note on sparse
Browse files Browse the repository at this point in the history
  • Loading branch information
avik-pal committed Feb 5, 2024
1 parent b04170e commit 812f6fb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/src/basics/autodiff.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@
If `PolyesterForwardDiff.jl` is installed and loaded, then `SimpleNonlinearSolve.jl`
will automatically use `AutoPolyesterForwardDiff` as the default AD backend.

!!! note

The `Sparse` versions of the methods refers to automated sparsity detection. These
methods automatically discover the sparse Jacobian form from the function `f`. Note that
all methods specialize the differentiation on a sparse Jacobian if the sparse Jacobian
is given as `prob.f.jac_prototype` in the `NonlinearFunction` definition, and the
`AutoSparse` here simply refers to whether this `jac_prototype` should be generated
automatically. For more details, see
[SparseDiffTools.jl](https://github.com/JuliaDiff/SparseDiffTools.jl) and
[Sparsity Detection Manual Entry](@ref sparsity-detection).

## API Reference

### Finite Differencing Backends
Expand Down

0 comments on commit 812f6fb

Please sign in to comment.