Skip to content
This repository was archived by the owner on Aug 22, 2025. It is now read-only.

Commit 7dc407a

Browse files
Update README.md
1 parent d97039e commit 7dc407a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,9 @@ DiffEqDiffTools.jl and for automatic differentiation is provided by
145145
ForwardDiff.jl.
146146

147147
For DiffEqDiffTools.jl, one simply has to use the provided `colorvec` keyword
148-
argument. See [the DiffEqDiffTools Jacobian documentation](https://github.com/JuliaDiffEq/DiffEqDiffTools.jl#jacobians) for more details.
148+
argument. See
149+
[the DiffEqDiffTools Jacobian documentation](https://github.com/JuliaDiffEq/DiffEqDiffTools.jl#jacobians)
150+
for more details.
149151

150152
For forward-mode automatic differentiation, use of a colorvec vector is provided
151153
by the following function:
@@ -160,8 +162,9 @@ forwarddiff_color_jacobian!(J::AbstractMatrix{<:Number},
160162
```
161163

162164
Notice that if a sparsity pattern is not supplied then the built Jacobian will
163-
be the compressed Jacobian: `sparsity` must be a sparse matrix with the appropriate
164-
sparsity pattern to allow for decompression.
165+
be the compressed Jacobian: `sparsity` must be a sparse matrix or a structured matrix
166+
(`Tridiagonal`, `Banded`, etc. conforming to the ArrayInterface.jl specs) with the
167+
appropriate sparsity pattern to allow for decompression.
165168

166169
This call will allocate the cache variables each time. To avoid allocating the
167170
cache, construct the cache in advance:

0 commit comments

Comments
 (0)