Skip to content

Make *Mahalanobis throw #233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Make *Mahalanobis throw #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a63a12
Make `*Mahalanobis` throw
dkarrasch Oct 26, 2021
0f70f7a
Merge branch 'master' into dk/mahathrow
dkarrasch Sep 12, 2022
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
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "Distances"
uuid = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"
version = "0.10.7"
version = "0.11.0"

[deps]
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
10 changes: 4 additions & 6 deletions src/mahalanobis.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@ Mahalanobis{Matrix{Int64}}([1 4 7; 2 5 8; 3 6 9])
struct Mahalanobis{M<:AbstractMatrix} <: Metric
qmat::M
function Mahalanobis(Q::AbstractMatrix; skipchecks::Bool=false)
# TODO: turn the warnings into errors in next breaking release
ishermitian(Q) || @warn "matrix is not symmetric/Hermitian"
ishermitian(Q) || throw(ArgumentError("matrix is not symmetric/Hermitian"))
if !skipchecks
eigmin(Q) ≥ 0 || @warn "matrix is not positive semidefinite"
eigmin(Q) ≥ 0 || throw(ArgumentError("matrix is not positive semidefinite"))
end
return new{typeof(Q)}(Q)
end
Expand Down Expand Up @@ -53,10 +52,9 @@ SqMahalanobis{Matrix{Int64}}([1 4 7; 2 5 8; 3 6 9])
struct SqMahalanobis{M<:AbstractMatrix} <: SemiMetric
qmat::M
function SqMahalanobis(Q::AbstractMatrix; skipchecks::Bool=false)
# TODO: turn the warnings into errors in next breaking release
ishermitian(Q) || @warn "matrix is not symmetric/Hermitian"
ishermitian(Q) || throw(ArgumentError("matrix is not symmetric/Hermitian"))
if !skipchecks
eigmin(Q) ≥ 0 || @warn "matrix is not positive semidefinite"
eigmin(Q) ≥ 0 || throw(ArgumentError("matrix is not positive semidefinite"))
end
return new{typeof(Q)}(Q)
end
Expand Down
16 changes: 6 additions & 10 deletions test/test_dists.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,17 +452,13 @@ end
end
A = rand(T, length(x), length(x))
S = A + A' - I
# TODO: let Distances.jl throw in next breaking release
# @test_throws ArgumentError SqMahalanobis(A)
@test_logs (:warn, "matrix is not positive semidefinite") SqMahalanobis(S)
# TODO: let Distances.jl throw in next breaking release
# @test_throws ArgumentError Mahalanobis(A)
@test_logs (:warn, "matrix is not positive semidefinite") Mahalanobis(S)
@test_throws ArgumentError SqMahalanobis(A)
@test_throws ArgumentError SqMahalanobis(S)
@test_throws ArgumentError Mahalanobis(A)
@test_throws ArgumentError Mahalanobis(S)
# test that semiposdef'ness can be overwritten, avoiding all checks
@test_logs (:warn, "matrix is not symmetric/Hermitian") SqMahalanobis(A, skipchecks=true)
@test SqMahalanobis(A, skipchecks=true) isa SemiMetric
@test_logs (:warn, "matrix is not symmetric/Hermitian") Mahalanobis(A, skipchecks=true)
@test Mahalanobis(A, skipchecks=true) isa Metric
@test_throws ArgumentError SqMahalanobis(A, skipchecks=true)
@test_throws ArgumentError Mahalanobis(A, skipchecks=true)
@test SqMahalanobis(S, skipchecks=true) isa SemiMetric
@test Mahalanobis(S, skipchecks=true) isa Metric
end
Expand Down