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

Commit 827a94f

Browse files
Merge pull request #201 from ElOceanografo/patch-1
Fix function name in Hessian example in README
2 parents c570ca7 + 556052d commit 827a94f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,8 +212,8 @@ and a color vector and sparsity pattern, this can be accomplished using
212212
`numauto_color_hessian` or its in-place form `numauto_color_hessian!`.
213213

214214
```julia
215-
H = numauto_color_hessian(fscalar, x, colorvec, sparsity)
216-
numauto_color_hessian!(H, fscalar, x, colorvec, sparsity)
215+
H = numauto_color_hessian(f, x, colorvec, sparsity)
216+
numauto_color_hessian!(H, f, x, colorvec, sparsity)
217217
```
218218

219219
To avoid unnecessary allocations every time the Hessian is computed,
@@ -230,7 +230,7 @@ Alternatively, if you have your own custom gradient function `g!`, you can speci
230230
it as an argument to `ForwardColorHesCache`:
231231

232232
```julia
233-
hescache = ForwardColorHesCache(fscalar, x, colorvec, sparsity, g!)
233+
hescache = ForwardColorHesCache(f, x, colorvec, sparsity, g!)
234234
```
235235
Note that any user-defined gradient needs to have the signature `g!(G, x)`,
236236
i.e. updating the gradient `G` in place.
@@ -356,4 +356,4 @@ ArrayInterfaceBlockBandedMatrices.jl to basically work with any functionality
356356
for sparsity patterns. In the future, those two packages should just depend on
357357
ArrayInterface.jl and remove this issue entirely from the user space.
358358

359-
Additionally, GPUs need ArrayInterfaceGPUArrays for proper determination of the indexing.
359+
Additionally, GPUs need ArrayInterfaceGPUArrays for proper determination of the indexing.

0 commit comments

Comments
 (0)