refactor: move SparseArrays into an extension

Author: avik-pal

Project.toml

@@ -1,17 +1,22 @@
 name = "MaybeInplace"
 uuid = "bb5d69b7-63fc-4a16-80bd-7e42200c7bdb"
 authors = ["Avik Pal <avikpal@mit.edu> and contributors"]
-version = "0.1.3"
+version = "0.1.4"
 
 [deps]
 ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
+
+[extensions]
+MaybeInplaceSparseArraysExt = "SparseArrays"
+
+[weakdeps]
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [compat]
 ArrayInterface = "7.6"
-LinearAlgebra = "<0.0.1, 1"
+LinearAlgebra = "1.9"
 MacroTools = "0.5"
-SparseArrays = "<0.0.1, 1"
+SparseArrays = "1.9"
 julia = "1.9"

ext/MaybeInplaceSparseArraysExt.jl

@@ -0,0 +1,11 @@
+module MaybeInplaceSparseArraysExt
+
+using MaybeInplace: MaybeInplace
+using SparseArrays: AbstractSparseArray
+
+# Sparse Arrays `mul!` has really bad performance
+# This works around it, and also potentially allows dispatching for other array types
+MaybeInplace.__mul!(C::AbstractSparseArray, A, B) = (C .= A * B)
+MaybeInplace.__mul!(C::AbstractSparseArray, A, B, α, β) = (C .= α * A * B .+ β * C)
+
+end

src/MaybeInplace.jl

@@ -1,8 +1,8 @@
 module MaybeInplace
 
-using LinearAlgebra, MacroTools, SparseArrays
-import ArrayInterface: can_setindex, restructure
-import SparseArrays: AbstractSparseArray
+using LinearAlgebra: LinearAlgebra, axpy!, mul!
+using MacroTools: MacroTools, @capture
+using ArrayInterface: can_setindex, restructure
 
 ## Documentation
 __bangbang__docs = """
@@ -304,12 +304,8 @@ const OP_MAPPING = Dict{Symbol, Function}(:copyto! => __copyto!!, :.-= => __sub!
     return :(@. y += α * x)
 end
 
-# Sparse Arrays `mul!` has really bad performance
-# This works around it, and also potentially allows dispatching for other array types
 __mul!(C, A, B) = mul!(C, A, B)
-__mul!(C::AbstractSparseArray, A, B) = (C .= A * B)
 __mul!(C, A, B, α, β) = mul!(C, A, B, α, β)
-__mul!(C::AbstractSparseArray, A, B, α, β) = (C .= α * A * B .+ β * C)
 
 ## Macros
 for m in (:bangbang, :bb, :❗)

test/Project.toml

@@ -2,5 +2,6 @@
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
 JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f"
+SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

test/basictests.jl

@@ -1,4 +1,4 @@
-using MaybeInplace, StaticArrays, Test
+using MaybeInplace, StaticArrays, Test, SparseArrays
 
 function copyto!!(y, x)
     @bb copyto!(y, x)
@@ -92,6 +92,11 @@ end
     z = @SVector[1.0, 1.0]
     @test matmul!!(y, x, z) == @SVector[2.0, 2.0]
     @test y == @SVector[0.0, 0.0]
+
+    x = sprand(100, 100, 0.01)
+    z = sprand(100, 100, 0.01)
+    y = x * z
+    @test matmul!!(y, x, z) == x * z
 end
 
 @testset "similar" begin