diff --git a/README.md b/README.md index 9ca484a..2a6c3fc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # TaylorTest 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 +```