add docstring and update README
This commit is contained in:
parent
df83c79e20
commit
0725b1bc58
1 changed files with 17 additions and 0 deletions
17
README.md
17
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
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue