add docstring and update README

This commit is contained in:
Gaspard Jankowiak 2025-02-10 12:26:36 +01:00
commit 0725b1bc58

View file

@ -1,3 +1,20 @@
# TaylorTest # TaylorTest
Simple package to check derivatives Simple package to check derivatives
# Usage
```
check(f, Jf, x[, constant_components]; f_kwargs...)
```
Returns true if `Jf` approximates the derivative/gradient/Jacobian of `f` at point `x` (along a random direction).
`f_kwargs` are keywords arguments to be passed to `f` and `Jf`.
`constant_components` is an optional `Vector{Int}` corresponding to components of the direction which should be set to zero,
effectively ignoring the dependency of `f` on these components.
## Examples
```julia-repl
julia> f = x -> cos(x); Jf = x -> -sin(x); check(f, Jf, rand())
true
```