Skip to content

Specialize iterate for IndexLinear arrays #58635

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 11 commits into from
Jun 10, 2025
Merged

Specialize iterate for IndexLinear arrays #58635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
424e50c
Specialize iterate for `IndexLinear` arrays
jishnub Jun 4, 2025
20acc8d
Call `IndexLinear` eachindex explicitly in linear-indexing `_iterate`
jishnub Jun 4, 2025
38d3133
Add oneunit instead of 1 to state
jishnub Jun 4, 2025
c10438d
Update stracktrace test
jishnub Jun 5, 2025
88e31e6
Remove `@inbounds`
jishnub Jun 5, 2025
7ce0401
Use step instead of adding oneunit
jishnub Jun 6, 2025
0bccdef
Disable bounds-checking for performance
jishnub Jun 6, 2025
af6d324
Use `checkindex` instead of custom function
jishnub Jun 6, 2025
b63a61d
Test for non-unit step
jishnub Jun 6, 2025
8fcde2c
Use checkbounds instead of checkindex
jishnub Jun 6, 2025
c6e425e
Rename to `iterate_starting_state`
jishnub Jun 9, 2025
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
10 changes: 9 additions & 1 deletion base/abstractarray.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1234,11 +1234,19 @@ oneunit(x::AbstractMatrix{T}) where {T} = _one(oneunit(T), x)
# While the definitions for IndexLinear are all simple enough to inline on their
# own, IndexCartesian's CartesianIndices is more complicated and requires explicit
# inlining.
function iterate(A::AbstractArray, state=(eachindex(A),))
iterate_starting_state(A) = iterate_starting_state(A, IndexStyle(A))
iterate_starting_state(A, ::IndexLinear) = firstindex(A)
iterate_starting_state(A, ::IndexStyle) = (eachindex(A),)
iterate(A::AbstractArray, state = iterate_starting_state(A)) = _iterate(A, state)
function _iterate(A::AbstractArray, state::Tuple)
y = iterate(state...)
y === nothing && return nothing
A[y[1]], (state[1], tail(y)...)
end
function _iterate(A::AbstractArray, state::Integer)
checkbounds(Bool, A, state) || return nothing
@inbounds(A[state]), state + one(state)
end

isempty(a::AbstractArray) = (length(a) == 0)

Expand Down
10 changes: 10 additions & 0 deletions test/abstractarray.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2286,3 +2286,13 @@ end
@test_throws "no method matching $Int(::$Infinity)" similar(ones(2), OneToInf())
end
end

@testset "iterate for linear indexing" begin
A = [1 2; 3 4]
v = view(A, :)
@test sum(x for x in v) == sum(A)
v = view(A, 1:2:lastindex(A))
@test sum(x for x in v) == sum(A[1:2:end])
v2 = view(A, Base.IdentityUnitRange(1:length(A)))
@test sum(x for x in v2) == sum(A)
end
2 changes: 1 addition & 1 deletion test/stacktraces.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ struct F49231{a,b,c,d,e,f,g} end
stacktrace(catch_backtrace())
end
str = sprint(Base.show_backtrace, st, context = (:limit=>true, :stacktrace_types_limited => Ref(false), :color=>true, :displaysize=>(50,105)))
@test contains(str, "[5] \e[0m\e[1mcollect_to!\e[22m\e[0m\e[1m(\e[22m\e[90mdest\e[39m::\e[0mVector\e[90m{…}\e[39m, \e[90mitr\e[39m::\e[0mBase.Generator\e[90m{…}\e[39m, \e[90moffs\e[39m::\e[0m$Int, \e[90mst\e[39m::\e[0mTuple\e[90m{…}\e[39m\e[0m\e[1m)\e[22m\n\e[90m")
@test contains(str, "[5] \e[0m\e[1mcollect_to!\e[22m\e[0m\e[1m(\e[22m\e[90mdest\e[39m::\e[0mVector\e[90m{…}\e[39m, \e[90mitr\e[39m::\e[0mBase.Generator\e[90m{…}\e[39m, \e[90moffs\e[39m::\e[0m$Int, \e[90mst\e[39m::\e[0m$Int\e[0m\e[1m)\e[22m\n\e[90m")

st = try
F49231{Vector,Val{'}'},Vector{Vector{Vector{Vector}}},Tuple{Int,Int,Int,Int,Int,Int,Int},Int,Int,Int}()(1,2,3)
Expand Down