27 lines
647 B
Markdown
27 lines
647 B
Markdown
# 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
|
|
import TaylorTest
|
|
|
|
f = x -> cos(x)
|
|
Jf = x -> -sin(x)
|
|
|
|
TaylorTest.check(f, Jf, rand())
|
|
|
|
# [ Info: Approximation order ~ 1.0
|
|
# true
|
|
```
|