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

Mutable addition and substraction of sparse arrays #281

Merged
merged 4 commits into from
Apr 24, 2024
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
24 changes: 17 additions & 7 deletions src/implementations/LinearAlgebra.jl
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,17 @@ function _check_dims(A, B)
return
end

function operate!(op::Union{typeof(+),typeof(-)}, A::Array, B::AbstractArray)
function operate!(
op::Union{typeof(+),typeof(-)},
A::AbstractArray,
B::AbstractArray,
)
_check_dims(A, B)
return broadcast!(op, A, B)
end

function operate_to!(
output::Array,
output::AbstractArray,
op::Union{typeof(+),typeof(-)},
A::AbstractArray,
B::AbstractArray,
Expand All @@ -116,7 +120,7 @@ end
# We call `scaling_to_number` as `UniformScaling` do not support broadcasting
function operate!(
op::AddSubMul,
A::Array,
A::AbstractArray,
B::AbstractArray,
α::Vararg{Scaling,M},
) where {M}
Expand All @@ -126,7 +130,7 @@ end

function operate!(
op::AddSubMul,
A::Array,
A::AbstractArray,
α::Scaling,
B::AbstractArray,
β::Vararg{Scaling,M},
Expand All @@ -137,7 +141,7 @@ end

function operate!(
op::AddSubMul,
A::Array,
A::AbstractArray,
α1::Scaling,
α2::Scaling,
B::AbstractArray,
Expand All @@ -156,11 +160,17 @@ end

# Fallback, we may be able to be more efficient in more cases by adding more
# specialized methods.
function operate!(op::AddSubMul, A::Array, x, y)
function operate!(op::AddSubMul, A::AbstractArray, x, y)
return operate!(op, A, x * y)
end

function operate!(op::AddSubMul, A::Array, x, y, args::Vararg{Any,N}) where {N}
function operate!(
op::AddSubMul,
A::AbstractArray,
x,
y,
args::Vararg{Any,N},
) where {N}
@assert N > 0
return operate!(op, A, x, *(y, args...))
end
Expand Down
30 changes: 29 additions & 1 deletion test/matmul.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import MutableArithmetics as MA

struct CustomArray{T,N} <: AbstractArray{T,N} end

import LinearAlgebra
import LinearAlgebra, SparseArrays

function dot_test(x, y)
@test MA.operate(LinearAlgebra.dot, x, y) == LinearAlgebra.dot(x, y)
Expand Down Expand Up @@ -119,13 +119,26 @@ end
"Cannot sum or substract a matrix of axes `$(axes(B))` into matrix of axes `$(axes(A))`, expected axes `$(axes(B))`.",
)
@test_throws err MA.operate!(+, A, B)
A = SparseArrays.spzeros(2)
B = SparseArrays.spzeros(2, 1)
err = DimensionMismatch(
"Cannot sum or substract a matrix of axes `$(axes(B))` into matrix of axes `$(axes(A))`, expected axes `$(axes(B))`.",
)
@test_throws err MA.operate!(+, A, B)
output = zeros(2)
A = zeros(2, 1)
B = zeros(2, 1)
err = DimensionMismatch(
"Cannot sum or substract matrices of axes `$(axes(A))` and `$(axes(B))` into a matrix of axes `$(axes(output))`, expected axes `$(axes(B))`.",
)
@test_throws err MA.operate_to!(output, +, A, B)
output = SparseArrays.spzeros(2)
A = SparseArrays.spzeros(2, 1)
B = SparseArrays.spzeros(2, 1)
err = DimensionMismatch(
"Cannot sum or substract matrices of axes `$(axes(A))` and `$(axes(B))` into a matrix of axes `$(axes(output))`, expected axes `$(axes(B))`.",
)
@test_throws err MA.operate_to!(output, +, A, B)
end
@testset "unsupported_product" begin
unsupported_product()
Expand Down Expand Up @@ -454,6 +467,21 @@ function test_array_sum(::Type{T}) where {T}
return
end

function test_sparse_vector_sum(::Type{T}) where {T}
x = SparseArrays.sparsevec([1, 3], T[5, 7])
y = copy(x)
z = copy(y)
alloc_test(() -> MA.operate!(+, y, z), 0)
alloc_test(() -> MA.operate!(-, y, z), 0)
alloc_test(() -> MA.add!!(y, z), 0)
alloc_test(() -> MA.sub!!(y, z), 0)
alloc_test(() -> MA.operate_to!(x, +, y, z), 0)
alloc_test(() -> MA.operate_to!(x, -, y, z), 0)
alloc_test(() -> MA.add_to!!(x, y, z), 0)
alloc_test(() -> MA.sub_to!!(x, y, z), 0)
return
end

@testset "Array sum" begin
test_array_sum(Int)
end
Loading