Skip to content

Store shape parameters as immutable values #13

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

Closed
wants to merge 3 commits into from
Closed

Store shape parameters as immutable values #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15cf02f
Fix behavior of `copy` and `similar`
MilesCranmer Mar 20, 2024
0b06463
Formatting
MilesCranmer Mar 20, 2024
b2155b9
Cache shape parameters of `ReadOnlyArray`
MilesCranmer Mar 20, 2024
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
37 changes: 25 additions & 12 deletions src/ReadOnlyArrays.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,22 @@ CanonicalIndexError: setindex! not defined for ReadOnlyArray{Int64,2,Array{Int64
[...]
```
"""
struct ReadOnlyArray{T,N,A} <: AbstractArray{T,N}
struct ReadOnlyArray{T,N,A,LE,SI,AX,I} <: AbstractArray{T,N}
parent::A
_length::LE
_size::SI
_axes::AX
_firstindex::I
_lastindex::I

function ReadOnlyArray(parent::AbstractArray{T,N}) where {T,N}
new{T,N,typeof(parent)}(parent)
_l = length(parent)
_s = size(parent)
_a = axes(parent)
_f = firstindex(parent)
_l = lastindex(parent)
_I = typejoin(typeof(_f), typeof(_l))
new{T,N,typeof.((parent,_l,_s,_a))...,_I}(parent, _l, _s, _a, _f, _l)
end
end

Expand All @@ -57,7 +69,16 @@ ReadOnlyMatrix(parent::AbstractMatrix) = ReadOnlyArray(parent)
# interface, excluding setindex!() and similar()
# https://docs.julialang.org/en/v1/manual/interfaces/#man-interface-parentay

Base.size(x::ReadOnlyArray, args...) = size(x.parent, args...)
Base.size(x::ReadOnlyArray) = x._size
Base.length(x::ReadOnlyArray) = x._length
Base.axes(x::ReadOnlyArray) = x._axes
Base.firstindex(x::ReadOnlyArray) = x._firstindex
Base.lastindex(x::ReadOnlyArray) = x._lastindex

# Special caching for `Array`
Base.size(a::ReadOnlyArray{<:Any,<:Any,<:Array}, d::Integer) = x._size[d]

Base.size(x::ReadOnlyArray, arg, args...) = size(x.parent, arg, args...)

@propagate_inbounds function Base.getindex(x::ReadOnlyArray, args...)
getindex(x.parent, args...)
Expand All @@ -67,11 +88,7 @@ Base.IndexStyle(::Type{<:ReadOnlyArray{T,N,P}}) where {T,N,P} = IndexStyle(P)

Base.iterate(x::ReadOnlyArray, args...) = iterate(x.parent, args...)

Base.length(x::ReadOnlyArray) = length(x.parent)

Base.similar(x::ReadOnlyArray) = similar(x.parent) |> ReadOnlyArray

Base.axes(x::ReadOnlyArray) = axes(x.parent)
Base.similar(x::ReadOnlyArray) = similar(x.parent)

function Base.IteratorSize(::Type{<:ReadOnlyArray{T,N,P}}) where {T,N,P}
Base.IteratorSize(P)
Expand All @@ -85,10 +102,6 @@ function Base.eltype(::Type{<:ReadOnlyArray{T,N,P}}) where {T,N,P}
eltype(P)
end

Base.firstindex(x::ReadOnlyArray) = firstindex(x.parent)

Base.lastindex(x::ReadOnlyArray) = lastindex(x.parent)

Base.strides(x::ReadOnlyArray) = strides(x.parent)

function Base.unsafe_convert(p::Type{Ptr{T}}, x::ReadOnlyArray) where {T}
Expand Down
6 changes: 6 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ end
fa = f()
@test fa isa ReadOnlyArray{Float64,2}
@test fa == x

a = ReadOnly([1, 2])
@test typeof(similar(a)) === Vector{Int64}

@test copy(a) == [1, 2]
@test typeof(copy(a)) === Vector{Int64}
end
end

Expand Down