Skip to content

Throw an ArgumentError from cholesky and ldlt for an index type CHOLMOD cannot take #1117

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

Merged
ViralBShah merged 1 commit into from
Oct 26, 2026
Merged

Throw an ArgumentError from cholesky and ldlt for an index type CHOLMOD cannot take #1117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 31 additions & 20 deletions src/solvers/cholmod.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1166,8 +1166,19 @@ function Sparse{Tv, Ti}(A::SparseMatrixCSC{<:Any}, stype::Integer) where {Tv<:VT
check_sparse(o)
return o
end

# CHOLMOD takes Int32 or Int64 indices; other index types are promoted with Int
function cholmod_itype(A, ::Type{Ti}) where {Ti}
Ti <: ITypes && return Ti
T = promote_type(Ti, Int)
T <: ITypes || throw(ArgumentError(string("matrix type ", typeof(A), " not supported: ",
"CHOLMOD needs an index type of ", join(Base.uniontypes(ITypes), " or "), ". ",
"Try converting its index type to Int first.")))
return T
end

Sparse{Tv}(A::SparseMatrixCSC{<:Any, Ti}, stype::Integer) where {Tv<:VTypes, Ti} =
Sparse{Tv, Ti <: ITypes ? Ti : promote_type(Ti, Int)}(A, stype)
Sparse{Tv, cholmod_itype(A, Ti)}(A, stype)
# handle promotion
function Sparse(A::SparseMatrixCSC{Tv}, stype::Integer) where {Tv}
T = promote_type(Tv, Float64)
Expand All @@ -1191,7 +1202,7 @@ function Sparse{Tv, Ti}(A::SparseMatrixCSC) where {Tv<:VTypes, Ti<:ITypes}
o
end
Sparse{Tv}(A::SparseMatrixCSC{<:Any, Ti}) where {Tv<:VTypes, Ti} =
Sparse{Tv, Ti <: ITypes ? Ti : promote_type(Ti, Int)}(A)
Sparse{Tv, cholmod_itype(A, Ti)}(A)
function Sparse(A::SparseMatrixCSC{Tv}) where {Tv}
T = promote_type(Tv, Float64)
return Sparse{T}(A)
Expand All @@ -1206,19 +1217,19 @@ Sparse{Tv, Ti}(A::Hermitian{<:Any, <:SparseMatrixCSC}) where {Tv<:VTypes, Ti<:IT
Sparse{Tv, Ti}(A.data, A.uplo == 'L' ? -1 : 1)

Sparse(A::Symmetric{Tv, SparseMatrixCSC{Tv,Ti}}) where {Tv<:Real, Ti} =
Sparse{promote_type(Tv, Float64), Ti <: ITypes ? Ti : promote_type(Ti, Int)}(
Sparse{promote_type(Tv, Float64), cholmod_itype(A, Ti)}(
A.data, A.uplo == 'L' ? -1 : 1
)
Sparse(A::Symmetric{Tv, SparseMatrixCSC{Tv,Ti}}) where {Tv<:Union{Float16, Float32}, Ti} =
Sparse{Float32, Ti <: ITypes ? Ti : promote_type(Ti, Int)}(A.data, A.uplo == 'L' ? -1 : 1)
Sparse{Float32, cholmod_itype(A, Ti)}(A.data, A.uplo == 'L' ? -1 : 1)

Sparse(A::Hermitian{Tv, SparseMatrixCSC{Tv,Ti}}) where {Tv, Ti} =
Sparse{promote_type(Tv, Float64), Ti <: ITypes ? Ti : promote_type(Ti, Int)}(
Sparse{promote_type(Tv, Float64), cholmod_itype(A, Ti)}(
A.data, A.uplo == 'L' ? -1 : 1
)
Sparse(A::Hermitian{Tv, SparseMatrixCSC{Tv,Ti}}) where
{Tv<:Union{Float16, Float32, ComplexF32, ComplexF16}, Ti} =
Sparse{promote_type(Float32, Tv), Ti <: ITypes ? Ti : promote_type(Ti, Int)}(
Sparse{promote_type(Float32, Tv), cholmod_itype(A, Ti)}(
A.data, A.uplo == 'L' ? -1 : 1
)

Expand Down Expand Up @@ -1738,13 +1749,13 @@ true
Input matrices not of those element types will
be converted to these types as appropriate.
"""
cholesky!(F::Factor, A::Union{SparseMatrixCSC{T, Ti},
SparseMatrixCSC{Complex{T}, Ti},
Symmetric{T,<:SparseMatrixCSC{T, Ti}},
Hermitian{Complex{T},<:SparseMatrixCSC{Complex{T}, Ti}},
Hermitian{T,<:SparseMatrixCSC{T, Ti}}};
shift = 0.0, check::Bool = true) where {T<:Real, Ti} =
cholesky!(F, Sparse{eltype(F), Ti}(A); shift = shift, check = check)
cholesky!(F::Factor{Tv, Ti}, A::Union{SparseMatrixCSC{T},
SparseMatrixCSC{Complex{T}},
Symmetric{T,<:SparseMatrixCSC{T}},
Hermitian{Complex{T},<:SparseMatrixCSC{Complex{T}}},
Hermitian{T,<:SparseMatrixCSC{T}}};
shift = 0.0, check::Bool = true) where {Tv, Ti, T<:Real} =
cholesky!(F, Sparse{Tv, Ti}(A); shift = shift, check = check)

function cholesky(A::Sparse; shift::Real=0.0, check::Bool = true,
perm::Union{Nothing,AbstractVector{<:Integer}}=nothing)
Expand Down Expand Up @@ -1928,13 +1939,13 @@ true
Input matrices not of those element types will
be converted to these types as appropriate.
"""
ldlt!(F::Factor, A::Union{SparseMatrixCSC{T, Ti},
SparseMatrixCSC{Complex{T}, Ti},
Symmetric{T, <:SparseMatrixCSC{T, Ti}},
Hermitian{Complex{T}, <:SparseMatrixCSC{Complex{T}, Ti}},
Hermitian{T, <:SparseMatrixCSC{T, Ti}}};
shift = 0.0, check::Bool = true) where {T<:Real, Ti} =
ldlt!(F, Sparse{eltype(F), Ti}(A), shift = shift, check = check)
ldlt!(F::Factor{Tv, Ti}, A::Union{SparseMatrixCSC{T},
SparseMatrixCSC{Complex{T}},
Symmetric{T, <:SparseMatrixCSC{T}},
Hermitian{Complex{T}, <:SparseMatrixCSC{Complex{T}}},
Hermitian{T, <:SparseMatrixCSC{T}}};
shift = 0.0, check::Bool = true) where {Tv, Ti, T<:Real} =
ldlt!(F, Sparse{Tv, Ti}(A), shift = shift, check = check)

function ldlt(A::Sparse; shift::Real=0.0, check::Bool = true,
perm::Union{Nothing,AbstractVector{<:Integer}}=nothing)
Expand Down
7 changes: 7 additions & 0 deletions test/solvers/issues.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,13 @@ end
@test F \ b ≈ Matrix(A) \ b
end

@testset "cholesky and cholesky! with an index type other than CHOLMOD's" begin
A = sparse([4.0 1 0; 1 4 1; 0 1 4])
@test_throws ArgumentError cholesky(SparseMatrixCSC{Float64,UInt64}(A))
F = cholesky(A)
@test cholesky!(F, SparseMatrixCSC{Float64,Int16}(2A)) \ [1.0, 2.0, 3.0] ≈ (2A) \ [1.0, 2.0, 3.0]
end

@testset "Issues #26367 and #26368" begin
A = sparse([0.0 1 0 0; 0 0 0 0])
F = qr(A)
Expand Down
Loading