Skip to content

Define in for CartesianIndex ranges #58616

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
merged 1 commit into from
Jun 16, 2025
Merged

Define in for CartesianIndex ranges #58616

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
18 changes: 18 additions & 0 deletions base/multidimensional.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,24 @@ module IteratorsMD
step(r), ", ", length(r), ")")
end

Base.in(x::CartesianIndex, r::AbstractRange{<:CartesianIndex}) = false
function Base.in(x::CartesianIndex{N}, r::AbstractRange{CartesianIndex{N}}) where {N}
isempty(r) && return false
f, st, l = first(r), step(r), last(r)
# The n-th element of the range is a CartesianIndex
# whose elements are the n-th along each dimension
# Find the first dimension along which the index is changing,
# so that n may be uniquely determined
for i in 1:N
iszero(st[i]) && continue
n = findfirst(==(x[i]), f[i]:st[i]:l[i])
isnothing(n) && return false
return r[n] == x
end
# if the step is zero, the elements are identical, so compare with the first
return x == f
end

# Iteration
const OrdinalRangeInt = OrdinalRange{Int, Int}
"""
Expand Down
39 changes: 39 additions & 0 deletions test/cartesian.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,3 +588,42 @@ end
@test I[begin] == I[1]
@test I[end] == I[2]
end

@testset "in for a CartesianIndex StepRangeLen" begin
@testset for l in [0, 1, 4], r in Any[
StepRangeLen(CartesianIndex(), CartesianIndex(), l),
StepRangeLen(CartesianIndex(1), CartesianIndex(0), l),
StepRangeLen(CartesianIndex(1), CartesianIndex(1), l),
StepRangeLen(CartesianIndex(1), CartesianIndex(4), l),
StepRangeLen(CartesianIndex(1), CartesianIndex(-4), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(0, 0), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(0, 4), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(0, -4), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(4, 0), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(-4, 0), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(4, 2), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(-4, 2), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(4, -2), l),
StepRangeLen(CartesianIndex(-1, 2), CartesianIndex(-4, -2), l),
StepRangeLen(CartesianIndex(-1, 2, 0), CartesianIndex(0, 0, 0), l),
StepRangeLen(CartesianIndex(-1, 2, 0), CartesianIndex(0, 0, -2), l),
]

if length(r) == 0
@test !(first(r) in r)
@test !(last(r) in r)
end
for x in r
@test x in r
if step(r) != oneunit(x)
@test !((x + oneunit(x)) in r)
end
end
@test !(CartesianIndex(ntuple(x->0, ndims(r))) in r)
@test !(CartesianIndex(ntuple(x->typemax(Int), ndims(r))) in r)
@test !(CartesianIndex(ntuple(x->typemin(Int), ndims(r))) in r)
if ndims(r) > 1
@test !(CartesianIndex(ntuple(x->0, ndims(r)-1)...) in r)
end
end
end