Skip to content

document require_one_based_indexing #43263

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 6 commits into from
May 17, 2022
Merged

document require_one_based_indexing #43263

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e7e8a11
document require_one_based_indexing
jw3126 Nov 30, 2021
2fcc3bb
Update base/abstractarray.jl
jw3126 Nov 30, 2021
5ed6929
add compat for require_one_based_indexing
jw3126 Nov 30, 2021
84c3fb5
Merge branch 'require1' of github.com:jw3126/julia into require1
jw3126 Nov 30, 2021
f4111fe
small updates
KristofferC May 17, 2022
7977655
Merge branch 'master' into require1
KristofferC May 17, 2022
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
12 changes: 12 additions & 0 deletions base/abstractarray.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,24 @@ end

Return `true` if the indices of `A` start with something other than 1 along any axis.
If multiple arguments are passed, equivalent to `has_offset_axes(A) | has_offset_axes(B) | ...`.

See also [`require_one_based_indexing`](@ref).
"""
has_offset_axes(A) = _tuple_any(x->Int(first(x))::Int != 1, axes(A))
has_offset_axes(A::AbstractVector) = Int(firstindex(A))::Int != 1 # improve performance of a common case (ranges)
has_offset_axes(A...) = _tuple_any(has_offset_axes, A)
has_offset_axes(::Colon) = false

"""
require_one_based_indexing(A::AbstractArray)
require_one_based_indexing(A,B...)

Throw an `ArgumentError` if the indices of any argument start with something other than `1` along any axis.
See also [`has_offset_axes`](@ref).

!!! compat "Julia 1.2"
This function requires at least Julia 1.2.
"""
require_one_based_indexing(A...) = !has_offset_axes(A...) || throw(ArgumentError("offset arrays are not supported but got an array with index other than 1"))

# Performance optimization: get rid of a branch on `d` in `axes(A, d)`
Expand Down