Skip to content

Commit

Permalink
Generalise Zeros +/- (#219)
Browse files Browse the repository at this point in the history 
* Update FillArrays.jl

* Update fillalgebra.jl

* Update runtests.jl

* 1.6 compatibility

* Update Project.toml

* Update fillalgebra.jl

---------

Co-authored-by: Sheehan Olver <[email protected]>
  • Loading branch information
@putianyi889 @dlfivefifty
putianyi889 and dlfivefifty authored Mar 16, 2023
1 parent 97862c5 commit 0c2d00c
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 80 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "FillArrays"
uuid = "1a297f60-69ca-5386-bcde-b61e274b549b"
version = "0.13.8"
version = "0.13.9"

[deps]
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
31 changes: 1 addition & 30 deletions src/FillArrays.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import Base: size, getindex, setindex!, IndexStyle, checkbounds, convert,
+, -, *, /, \, diff, sum, cumsum, maximum, minimum, sort, sort!,
any, all, axes, isone, iterate, unique, allunique, permutedims, inv,
copy, vec, setindex!, count, ==, reshape, _throw_dmrs, map, zero,
show, view, in, mapreduce, one, reverse
show, view, in, mapreduce, one, reverse, promote_op

import LinearAlgebra: rank, svdvals!, tril, triu, tril!, triu!, diag, transpose, adjoint, fill!,
dot, norm2, norm1, normInf, normMinusInf, normp, lmul!, rmul!, diagzero, AdjointAbsVec, TransposeAbsVec,
Expand Down Expand Up @@ -208,35 +208,6 @@ sort(a::AbstractFill; kwds...) = a
sort!(a::AbstractFill; kwds...) = a
svdvals!(a::AbstractFillMatrix) = [getindex_value(a)*sqrt(prod(size(a))); Zeros(min(size(a)...)-1)]

+(a::AbstractFill) = a
-(a::AbstractFill) = Fill(-getindex_value(a), size(a))

# Fill +/- Fill
function +(a::AbstractFill{T, N}, b::AbstractFill{V, N}) where {T, V, N}
axes(a) ≠ axes(b) && throw(DimensionMismatch("dimensions must match."))
return Fill(getindex_value(a) + getindex_value(b), axes(a))
end
-(a::AbstractFill, b::AbstractFill) = a + (-b)

function +(a::FillVector{T}, b::AbstractRange) where {T}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
Tout = promote_type(T, eltype(b))
return a.value .+ b
end
+(a::AbstractRange, b::AbstractFill) = b + a
# LinearAlgebra defines `+(a::UniformScaling, b::AbstractMatrix) = b + a`,
# so the implementation of `+(a::AbstractFill{<:Any,2}, b::UniformScaling)` is sufficient
function +(a::AbstractFillMatrix, b::UniformScaling)
n = LinearAlgebra.checksquare(a)
return a + Diagonal(Fill(b.λ, n))
end

-(a::AbstractFill, b::AbstractRange) = a + (-b)
-(a::AbstractRange, b::AbstractFill) = a + (-b)
# LinearAlgebra defines `-(a::AbstractMatrix, b::UniformScaling) = a + (-b)`,
# so the implementation of `-(a::UniformScaling, b::AbstractFill{<:Any,2})` is sufficient
-(a::UniformScaling, b::AbstractFillMatrix) = a + (-b)

function fill_reshape(parent, dims::Integer...)
n = length(parent)
prod(dims) == n || _throw_dmrs(n, "size", dims)
Expand Down
79 changes: 33 additions & 46 deletions src/fillalgebra.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,61 +211,48 @@ function dot(u::AbstractVector{T}, D::Diagonal{U,<:Zeros}, v::AbstractVector{V})
zero(promote_type(T,U,V))
end

+(a::Zeros) = a
-(a::Zeros) = a

# Zeros +/- Zeros
function +(a::Zeros{T}, b::Zeros{V}) where {T, V}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
return Zeros{promote_type(T,V)}(size(a)...)
# Addition and Subtraction
function +(a::Zeros{T}, b::Zeros{V}) where {T, V} # for disambiguity
promote_shape(a,b)
return elconvert(promote_op(+,T,V),a)
end
for TYPE in (:AbstractArray, :AbstractFill) # AbstractFill for disambiguity
@eval function +(a::$TYPE{T}, b::Zeros{V}) where {T, V}
promote_shape(a,b)
return elconvert(promote_op(+,T,V),a)
end
@eval +(a::Zeros, b::$TYPE) = b + a
end
-(a::Zeros, b::Zeros) = -(a + b)
-(a::Ones, b::Ones) = Zeros(a)+Zeros(b)

# Zeros +/- Fill and Fill +/- Zeros
function +(a::AbstractFill{T}, b::Zeros{V}) where {T, V}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
return AbstractFill{promote_type(T, V)}(a)
end
+(a::Zeros, b::AbstractFill) = b + a
-(a::AbstractFill, b::Zeros) = a + b
-(a::Zeros, b::AbstractFill) = a + (-b)

# Zeros +/- Array and Array +/- Zeros
function +(a::Zeros{T, N}, b::AbstractArray{V, N}) where {T, V, N}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
return AbstractArray{promote_type(T,V),N}(b)
end
function +(a::Array{T, N}, b::Zeros{V, N}) where {T, V, N}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
return AbstractArray{promote_type(T,V),N}(a)
# for VERSION other than 1.6, could use ZerosMatrix only
function +(a::AbstractFillMatrix{T}, b::UniformScaling) where {T}
n = checksquare(a)
return a + Diagonal(Fill(zero(T) + b.λ, n))
end

function -(a::Zeros{T, N}, b::AbstractArray{V, N}) where {T, V, N}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
return -b + a
end
-(a::Array{T, N}, b::Zeros{V, N}) where {T, V, N} = a + b
# LinearAlgebra defines `-(a::AbstractMatrix, b::UniformScaling) = a + (-b)`,
# so the implementation of `-(a::UniformScaling, b::AbstractFill{<:Any,2})` is sufficient
-(a::UniformScaling, b::AbstractFill) = -b + a # @test I-Zeros(3,3) === Diagonal(Ones(3))

-(a::Ones, b::Ones) = Zeros(a) + Zeros(b)

+(a::AbstractRange, b::Zeros) = b + a
# necessary for AbstractRange, Diagonal, etc
+(a::AbstractFill, b::AbstractFill) = fill_add(a, b)
+(a::AbstractFill, b::AbstractArray) = fill_add(b, a)
+(a::AbstractArray, b::AbstractFill) = fill_add(a, b)
-(a::AbstractFill, b::AbstractFill) = a + (-b)
-(a::AbstractFill, b::AbstractArray) = a + (-b)
-(a::AbstractArray, b::AbstractFill) = a + (-b)

function +(a::ZerosVector{T}, b::AbstractRange) where {T}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
Tout = promote_type(T, eltype(b))
return Tout(first(b)):Tout(step(b)):Tout(last(b))
end
function +(a::ZerosVector{T}, b::UnitRange) where {T<:Integer}
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
Tout = promote_type(T, eltype(b))
return AbstractUnitRange{Tout}(b)
@inline function fill_add(a, b::AbstractFill)
promote_shape(a, b)
a .+ getindex_value(b)
end

function -(a::ZerosVector, b::AbstractRange)
size(a) ≠ size(b) && throw(DimensionMismatch("dimensions must match."))
return -b + a
end
-(a::AbstractRange, b::ZerosVector) = a + b
# following needed since as of Julia v1.8 convert(AbstractArray{T}, ::AbstractRange) might return a Vector
@inline elconvert(::Type{T}, A::AbstractRange) where T = T(first(A)):T(step(A)):T(last(A))
@inline elconvert(::Type{T}, A::AbstractUnitRange) where T<:Integer = AbstractUnitRange{T}(A)
@inline elconvert(::Type{T}, A::AbstractArray) where T = AbstractArray{T}(A)

####
# norm
Expand Down
6 changes: 3 additions & 3 deletions test/runtests.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,9 @@ include("infinitearrays.jl")
y = x + x
@test y isa Fill{Int,1}
@test y[1] == 2
@test x + Zeros{Bool}(5) ≡ x
@test x - Zeros{Bool}(5) ≡ x
@test Zeros{Bool}(5) + x ≡ x
@test x + Zeros{Bool}(5) ≡ Ones{Int}(5)
@test x - Zeros{Bool}(5) ≡ Ones{Int}(5)
@test Zeros{Bool}(5) + x ≡ Ones{Int}(5)
@test -x ≡ Fill(-1,5)
end

Expand Down

2 comments on commit 0c2d00c

@dlfivefifty
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/79712

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.13.9 -m "<description of version>" 0c2d00cedbd8f5f0493468a09c286e9712573a13
git push origin v0.13.9

Also, note the warning: Version 0.13.9 skips over 0.13.8
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.