Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions src/basekernels/matern.jl
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ differentiable in the mean-square sense.

See also: [`Matern12Kernel`](@ref), [`Matern32Kernel`](@ref), [`Matern52Kernel`](@ref), [`Matern72Kernel`](@ref)
"""
struct MaternKernel{Tν<:Real,M} <: SimpleKernel
struct MaternKernel{Tν <: Real, M} <: SimpleKernel
ν::Vector{Tν}
metric::M

function MaternKernel(ν::Real, metric)
@check_args(MaternKernel, ν, ν > zero(ν), "ν > 0")
return new{typeof(ν),typeof(metric)}([ν], metric)
return new{typeof(ν), typeof(metric)}([ν], metric)
end
end

MaternKernel(; nu::Real=1.5, ν::Real=nu, metric=Euclidean()) = MaternKernel(ν, metric)
MaternKernel(; nu::Real = 1.5, ν::Real = nu, metric = Euclidean()) = MaternKernel(ν, metric)

@functor MaternKernel

Expand Down Expand Up @@ -78,9 +78,12 @@ struct Matern32Kernel{M} <: SimpleKernel
metric::M
end

Matern32Kernel(; metric=Euclidean()) = Matern32Kernel(metric)
Matern32Kernel(; metric = Euclidean()) = Matern32Kernel(metric)

kappa(::Matern32Kernel, d::Real) = (1 + sqrt(3) * d) * exp(-sqrt(3) * d)
function kappa(::Matern32Kernel, d::Real)
s = sqrt(3 * one(d))
return (1 + s * d) * exp(-s * d)
end

metric(k::Matern32Kernel) = k.metric

Expand Down Expand Up @@ -109,9 +112,12 @@ struct Matern52Kernel{M} <: SimpleKernel
metric::M
end

Matern52Kernel(; metric=Euclidean()) = Matern52Kernel(metric)
Matern52Kernel(; metric = Euclidean()) = Matern52Kernel(metric)

kappa(::Matern52Kernel, d::Real) = (1 + sqrt(5) * d + 5 * d^2 / 3) * exp(-sqrt(5) * d)
function kappa(::Matern52Kernel, d::Real)
s = sqrt(5 * one(d))
return (1 + s * d + 5 * d^2 / 3) * exp(-s * d)
end

metric(k::Matern52Kernel) = k.metric

Expand Down Expand Up @@ -140,10 +146,11 @@ struct Matern72Kernel{M} <: SimpleKernel
metric::M
end

Matern72Kernel(; metric=Euclidean()) = Matern72Kernel(metric)
Matern72Kernel(; metric = Euclidean()) = Matern72Kernel(metric)

function kappa(::Matern72Kernel, d::Real)
Comment thread
theogf marked this conversation as resolved.
Resolved
return (1 + sqrt(7) * d + 14 / 5 * d^2 + 7 * sqrt(7) / 15 * d^3) * exp(-sqrt(7) * d)
s = sqrt(7 * one(d))
return (1 + s * d + 14 * d^2 / 5 + 7 * s * d^3 / 15) * exp(-s * d)
end

metric(k::Matern72Kernel) = k.metric
Expand Down
44 changes: 24 additions & 20 deletions test/basekernels/matern.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,32 +5,33 @@
v2 = rand(rng, 3)
@testset "MaternKernel" begin
ν = 2.1
k = MaternKernel(; ν=ν)
k = MaternKernel(; ν = ν)
matern(x, ν) = 2^(1 - ν) / gamma(ν) * (sqrt(2ν) * x)^ν * besselk(ν, sqrt(2ν) * x)
@test MaternKernel(; nu=ν).ν == [ν]
@test MaternKernel(; nu = ν).ν == [ν]
@test kappa(k, x) ≈ matern(x, ν)
@test kappa(k, 0.0) == 1.0
@test metric(MaternKernel()) == Euclidean()
@test metric(MaternKernel(; ν=2.0)) == Euclidean()
@test metric(MaternKernel(; ν = 2.0)) == Euclidean()
@test repr(k) == "Matern Kernel (ν = $(ν), metric = Euclidean(0.0))"

k2 = MaternKernel(; ν=ν, metric=WeightedEuclidean(ones(3)))
k2 = MaternKernel(; ν = ν, metric = WeightedEuclidean(ones(3)))
@test metric(k2) isa WeightedEuclidean
@test k2(v1, v2) ≈ k(v1, v2)

# Standardised tests.
TestUtils.test_interface(k, Float64)
test_ADs(() -> MaternKernel(; nu=ν))
test_ADs(() -> MaternKernel(; nu = ν))
end
@testset "Matern32Kernel" begin
k = Matern32Kernel()
@test kappa(k, x) ≈ (1 + sqrt(3) * x)exp(-sqrt(3) * x)
@test k(v1, v2) ≈ (1 + sqrt(3) * norm(v1 - v2))exp(-sqrt(3) * norm(v1 - v2))
@test kappa(Matern32Kernel(), x) == kappa(k, x)
@test kappa(k, 0.5f0) isa Float32
@test metric(Matern32Kernel()) == Euclidean()
@test repr(k) == "Matern 3/2 Kernel (metric = Euclidean(0.0))"

k2 = Matern32Kernel(; metric=WeightedEuclidean(ones(3)))
k2 = Matern32Kernel(; metric = WeightedEuclidean(ones(3)))
@test metric(k2) isa WeightedEuclidean
@test k2(v1, v2) ≈ k(v1, v2)

Expand All @@ -42,14 +43,15 @@
k = Matern52Kernel()
@test kappa(k, x) ≈ (1 + sqrt(5) * x + 5 / 3 * x^2)exp(-sqrt(5) * x)
@test k(v1, v2) ≈
(
1 + sqrt(5) * norm(v1 - v2) + 5 / 3 * norm(v1 - v2)^2
)exp(-sqrt(5) * norm(v1 - v2))
(1 + sqrt(5) * norm(v1 - v2) + 5 / 3 * norm(v1 - v2)^2)exp(
-sqrt(5) * norm(v1 - v2),
)
@test kappa(Matern52Kernel(), x) == kappa(k, x)
@test kappa(k, 0.5f0) isa Float32
@test metric(Matern52Kernel()) == Euclidean()
@test repr(k) == "Matern 5/2 Kernel (metric = Euclidean(0.0))"

k2 = Matern52Kernel(; metric=WeightedEuclidean(ones(3)))
k2 = Matern52Kernel(; metric = WeightedEuclidean(ones(3)))
@test metric(k2) isa WeightedEuclidean
@test k2(v1, v2) ≈ k(v1, v2)

Expand All @@ -63,16 +65,18 @@
(1 + sqrt(7) * x + 14 / 5 * x^2 + 7 * sqrt(7) / 15 * x^3) * exp(-sqrt(7) * x)
@test k(v1, v2) ≈
(
1 +
sqrt(7) * norm(v1 - v2) +
14 / 5 * norm(v1 - v2)^2 +
7 * sqrt(7) / 15 * norm(v1 - v2)^3
) * exp(-sqrt(7) * norm(v1 - v2))
1 +
sqrt(7) * norm(v1 - v2) +
14 / 5 * norm(v1 - v2)^2 +
7 * sqrt(7) / 15 * norm(v1 - v2)^3
) *
exp(-sqrt(7) * norm(v1 - v2))
@test kappa(Matern72Kernel(), x) == kappa(k, x)
@test kappa(k, 0.5f0) isa Float32
@test metric(Matern72Kernel()) == Euclidean()
@test repr(k) == "Matern 7/2 Kernel (metric = Euclidean(0.0))"

k2 = Matern72Kernel(; metric=WeightedEuclidean(ones(3)))
k2 = Matern72Kernel(; metric = WeightedEuclidean(ones(3)))
@test metric(k2) isa WeightedEuclidean
@test k2(v1, v2) ≈ k(v1, v2)

Expand All @@ -81,9 +85,9 @@
test_ADs(Matern72Kernel)
end
@testset "Coherence Materns" begin
@test kappa(MaternKernel(; ν=0.5), x) ≈ kappa(ExponentialKernel(), x)
@test kappa(MaternKernel(; ν=1.5), x) ≈ kappa(Matern32Kernel(), x)
@test kappa(MaternKernel(; ν=2.5), x) ≈ kappa(Matern52Kernel(), x)
@test kappa(MaternKernel(; ν=3.5), x) ≈ kappa(Matern72Kernel(), x)
@test kappa(MaternKernel(; ν = 0.5), x) ≈ kappa(ExponentialKernel(), x)
@test kappa(MaternKernel(; ν = 1.5), x) ≈ kappa(Matern32Kernel(), x)
@test kappa(MaternKernel(; ν = 2.5), x) ≈ kappa(Matern52Kernel(), x)
@test kappa(MaternKernel(; ν = 3.5), x) ≈ kappa(Matern72Kernel(), x)
end
end
Loading