Skip to content
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.

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

Add a preference system for turning on/off slow fallbacks #402

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
88 changes: 52 additions & 36 deletions src/ArrayInterface.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
module ArrayInterface

const SLOWFALLBACKS = @load_preference("slow_fallbacks", true)

using LinearAlgebra
using SparseArrays
using SuiteSparse
Expand Down Expand Up @@ -282,7 +284,7 @@ function ismutable end
ismutable(::Type{T}) -> Bool

Query whether instances of type `T` are mutable or not, see
https://github.com/JuliaDiffEq/RecursiveArrayTools.jl/issues/19.
https://github.com/SciML/RecursiveArrayTools.jl/issues/19.
"""
ismutable(x) = ismutable(typeof(x))
function ismutable(::Type{T}) where {T <: AbstractArray}
Expand Down Expand Up @@ -460,12 +462,15 @@ Returns the number.
"""
bunchkaufman_instance(a::Number) = a

"""
bunchkaufman_instance(a::Any) -> cholesky(a, check=false)
@static if SLOWFALLBACKS
"""
bunchkaufman_instance(a::Any) -> cholesky(a, check=false)

Returns the number.
"""
bunchkaufman_instance(a::Any) = bunchkaufman(a, check = false)
Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
bunchkaufman_instance(a::Any) = bunchkaufman(a, check = false)
end

"""
cholesky_instance(A, pivot = LinearAlgebra.RowMaximum()) -> cholesky_factorization_instance
Expand All @@ -487,13 +492,15 @@ Returns the number.
"""
cholesky_instance(a::Number, pivot = LinearAlgebra.RowMaximum()) = a

"""
cholesky_instance(a::Any, pivot = LinearAlgebra.RowMaximum()) -> cholesky(a, check=false)
@static if SLOWFALLBACKS
"""
cholesky_instance(a::Any, pivot = LinearAlgebra.RowMaximum()) -> cholesky(a, check=false)

Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
cholesky_instance(a::Any, pivot = LinearAlgebra.RowMaximum()) = cholesky(a, pivot, check = false)
Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
cholesky_instance(a::Any, pivot = LinearAlgebra.RowMaximum()) = cholesky(a, pivot, check = false)
end

"""
ldlt_instance(A) -> ldlt_factorization_instance
Expand All @@ -515,13 +522,15 @@ Returns the number.
"""
ldlt_instance(a::Number) = a

"""
ldlt_instance(a::Any) -> ldlt(a, check=false)
@static if SLOWFALLBACKS
"""
ldlt_instance(a::Any) -> ldlt(a, check=false)

Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
ldlt_instance(a::Any) = ldlt(a)
Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
ldlt_instance(a::Any) = ldlt(a)
end

"""
lu_instance(A) -> lu_factorization_instance
Expand Down Expand Up @@ -558,13 +567,15 @@ Returns the number.
"""
lu_instance(a::Number) = a

"""
lu_instance(a::Any) -> lu(a, check=false)
@static if SLOWFALLBACKS
"""
lu_instance(a::Any) -> lu(a, check=false)

Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
lu_instance(a::Any) = lu(a, check = false)
Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
lu_instance(a::Any) = lu(a, check = false)
end

"""
qr_instance(A) -> qr_factorization_instance
Expand All @@ -588,13 +599,15 @@ Returns the number.
"""
qr_instance(a::Number) = a

"""
qr_instance(a::Any) -> qr(a)
@static if SLOWFALLBACKS
"""
qr_instance(a::Any) -> qr(a)

Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
qr_instance(a::Any) = qr(a)# check = false)
Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
qr_instance(a::Any) = qr(a)# check = false)
end

"""
svd_instance(A) -> qr_factorization_instance
Expand All @@ -613,13 +626,15 @@ Returns the number.
"""
svd_instance(a::Number) = a

"""
svd_instance(a::Any) -> svd(a)
@static if SLOWFALLBACKS
"""
svd_instance(a::Any) -> svd(a)

Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
svd_instance(a::Any) = svd(a) #check = false)
Slow fallback which gets the instance via factorization. Should get
specialized for new matrix types.
"""
svd_instance(a::Any) = svd(a) #check = false)
end

"""
safevec(v)
Expand Down Expand Up @@ -1034,3 +1049,4 @@ import Requires
end

end # module