Skip to content

Commit e57428f

Browse files
committed
Add a note on sparse
1 parent b04170e commit e57428f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/src/basics/autodiff.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@
2424
If `PolyesterForwardDiff.jl` is installed and loaded, then `SimpleNonlinearSolve.jl`
2525
will automatically use `AutoPolyesterForwardDiff` as the default AD backend.
2626

27+
!!! note
28+
29+
The `Sparse` versions of the methods refers to automated sparsity detection. These
30+
methods automatically discover the sparse Jacobian form from the function `f`. Note that
31+
all methods specialize the differentiation on a sparse Jacobian if the sparse Jacobian
32+
is given as `prob.f.jac_prototype` in the `NonlinearFunction` definition, and the
33+
`AutoSparse` here simply refers to whether this `jac_prototype` should be generated
34+
automatically. For more details, see
35+
[SparseDiffTools.jl](https://github.com/JuliaDiff/SparseDiffTools.jl) and
36+
[Sparsity Detection Manual Entry](@ref sparsity-detection).
37+
2738
## API Reference
2839

2940
### Finite Differencing Backends

0 commit comments

Comments
 (0)