Skip to content

Commit 4327ff2

Browse files
committed
add comment
1 parent dac45f7 commit 4327ff2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/TestUtils.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ Run various consistency checks on `k` at the inputs `x0`, `x1`, and `x2`.
2323
`x0` and `x1` should be of the same length with different values, while `x0` and `x2` should
2424
be of different lengths.
2525
26+
These tests are intended to pick up on really substantial issues with a kernel implementation
27+
(e.g. substantial asymmetry in the kernel matrix, large negative eigenvalues), rather than to
28+
test the numerics in detail, which can be kernel-specific.
29+
The default value of `__ATOL` and `__RTOL` is `sqrt(eps(Float64)) ≈ 1.5e-8`, which satisfied
30+
this intention in the cases tested within KernelFunctions.jl itself.
31+
2632
test_interface([rng::AbstractRNG], k::Kernel, T::Type{<:Real}; atol=__ATOL, rtol=__RTOL)
2733
2834
`test_interface` offers automated test data generation for kernels whose inputs are reals.

0 commit comments

Comments
 (0)