rename ZeroDimensionalArrayMutable* to Box* (#13)

Updates #7

Author: nsajko

README.md

@@ -13,10 +13,10 @@ Exports three zero-dimensional subtypes of `AbstractArray`:
     * declared with `struct`, not with `mutable struct`
     * does not support `setfield!`, or mutating the element otherwise
     * `isbits` when the element is `isbits`
-* `ZeroDimensionalArrayMutable`
+* `Box`
     * declared with `mutable struct`
     * supports `setfield!`
-* `ZeroDimensionalArrayMutableConstField`
+* `BoxConstField`
     * declared with `mutable struct`
     * does not support `setfield!`, or mutating the element otherwise
     * included for completeness, but not likely to be useful often
@@ -28,17 +28,17 @@ The motivation for creating this package is:
     * https://discourse.julialang.org/t/ref-is-not-a-concrete-type-poorly-documented/120375
     * https://discourse.julialang.org/t/ref-t-vs-base-refvalue-t/127886/
 * To provide "mutable wrapper" functionality, something `Ref` is often used for:
-    * `ZeroDimensionalArrayMutable` can be a good replacement. Examples:
+    * `Box` can be a good replacement. Examples:
         * make a `const` binding that's mutable:
           ```julia
-          const some_const_binding = ZeroDimensionalArrayMutable(0.2)
+          const some_const_binding = Box(0.2)
           ```
         * make a field within an immutable `struct` mutable (warning: it's usually more efficient to change the entire `struct` into a `mutable struct`)
           ```julia
           struct SomeImmutableType
               immutable_bool::Bool
               immutable_float::Float64
-              mutable_int::ZeroDimensionalArrayMutable{Int}
+              mutable_int::Box{Int}
           end
           ```
     * previous discussion:

src/ZeroDimensionalArrays.jl

@@ -2,8 +2,8 @@ module ZeroDimensionalArrays
 
 export
     ZeroDimensionalArrayImmutable,
-    ZeroDimensionalArrayMutable,
-    ZeroDimensionalArrayMutableConstField
+    Box,
+    BoxConstField
 
 struct ZeroDimensionalArrayImmutable{T} <: AbstractArray{T, 0}
     v::T
@@ -12,7 +12,7 @@ struct ZeroDimensionalArrayImmutable{T} <: AbstractArray{T, 0}
     end
 end
 
-mutable struct ZeroDimensionalArrayMutable{T} <: AbstractArray{T, 0}
+mutable struct Box{T} <: AbstractArray{T, 0}
     v::T
     global function new_zero_dimensional_array_mutable(::Type{T}, v) where {T}
         new{T}(v)
@@ -22,7 +22,7 @@ mutable struct ZeroDimensionalArrayMutable{T} <: AbstractArray{T, 0}
     end
 end
 
-mutable struct ZeroDimensionalArrayMutableConstField{T} <: AbstractArray{T, 0}
+mutable struct BoxConstField{T} <: AbstractArray{T, 0}
     const v::T
     global function new_zero_dimensional_array_mutable_const_field(::Type{T}, v) where {T}
         new{T}(v)
@@ -31,16 +31,16 @@ end
 
 const ZeroDimensionalArray = Union{
     ZeroDimensionalArrayImmutable,
-    ZeroDimensionalArrayMutable,
-    ZeroDimensionalArrayMutableConstField,
+    Box,
+    BoxConstField,
 }
 
 function type_to_constructor_function(::Type{T}) where {T <: ZeroDimensionalArray}
     if T <: ZeroDimensionalArrayImmutable
         new_zero_dimensional_array_immutable
-    elseif T <: ZeroDimensionalArrayMutable
+    elseif T <: Box
         new_zero_dimensional_array_mutable
-    elseif T <: ZeroDimensionalArrayMutableConstField
+    elseif T <: BoxConstField
         new_zero_dimensional_array_mutable_const_field
     else
         throw(ArgumentError("no such constructor function"))
@@ -63,7 +63,7 @@ function Base.getindex(a::ZeroDimensionalArray)
     a.v
 end
 
-function Base.setindex!(a::ZeroDimensionalArrayMutable, x)
+function Base.setindex!(a::Box, x)
     a.v = x
 end
 
@@ -101,8 +101,8 @@ end
 
 for Arr ∈ (
     ZeroDimensionalArrayImmutable,
-    ZeroDimensionalArrayMutable,
-    ZeroDimensionalArrayMutableConstField,
+    Box,
+    BoxConstField,
 )
     @eval begin
         function Base.convert(::Type{$Arr}, a::AbstractArray{<:Any, 0})
@@ -120,7 +120,7 @@ for Arr ∈ (
     end
 end
 
-function ZeroDimensionalArrayMutable{T}() where {T}
+function Box{T}() where {T}
     new_zero_dimensional_array_mutable_undef(T)
 end
 
@@ -136,7 +136,7 @@ end
 # ```
 
 # https://github.com/JuliaLang/julia/issues/51753
-if isdefined(Base, :dataids) && hasmethod(Base.dataids, Tuple{ZeroDimensionalArrayMutable{Float32}})
+if isdefined(Base, :dataids) && hasmethod(Base.dataids, Tuple{Box{Float32}})
     function Base.dataids(a::ZeroDimensionalArray)
         Base.dataids(only(a))
     end

test/runtests.jl

@@ -10,8 +10,8 @@ using Aqua: Aqua
     @testset "all array types joined" begin
         for Arr ∈ (
             ZeroDimensionalArrayImmutable,
-            ZeroDimensionalArrayMutable,
-            ZeroDimensionalArrayMutableConstField,
+            Box,
+            BoxConstField,
         )
             @test (@inferred Arr(0.3)) == (@inferred convert(Arr, fill(0.3)))
             @test isstructtype(Arr)
@@ -27,8 +27,8 @@ using Aqua: Aqua
             @test @inferred isassigned(Arr(0.3))
             @test @inferred isassigned(Arr(0.3), 1)
             @test !(isassigned(Arr(0.3), 2))
-            @test (@inferred similar(Arr(0.3))) isa ZeroDimensionalArrayMutable{Float64}
-            @test (@inferred similar(Arr(0.3), Float32)) isa ZeroDimensionalArrayMutable{Float32}
+            @test (@inferred similar(Arr(0.3))) isa Box{Float64}
+            @test (@inferred similar(Arr(0.3), Float32)) isa Box{Float32}
             @test fill(0.3) == Arr(0.3)
             @test Arr(0.3) == Arr(0.3)
             @test all(@inferred Arr(0.3) .== Arr(0.3))
@@ -42,18 +42,18 @@ using Aqua: Aqua
             @test !ismutabletype(ZeroDimensionalArrayImmutable)
             @test isbitstype(ZeroDimensionalArrayImmutable{Float64})
         end
-        @testset "`ZeroDimensionalArrayMutable`" begin
-            @test @isdefined ZeroDimensionalArrayMutable
-            @test ismutabletype(ZeroDimensionalArrayMutable)
-            @test (@inferred ZeroDimensionalArrayMutable{Float32}()) isa ZeroDimensionalArrayMutable{Float32}
-            @test let a = ZeroDimensionalArrayMutable(0.3)
+        @testset "`Box`" begin
+            @test @isdefined Box
+            @test ismutabletype(Box)
+            @test (@inferred Box{Float32}()) isa Box{Float32}
+            @test let a = Box(0.3)
                 a[] = 0.7
                 only(a) === 0.7
             end
         end
-        @testset "`ZeroDimensionalArrayMutableConstField`" begin
-            @test @isdefined ZeroDimensionalArrayMutableConstField
-            @test ismutabletype(ZeroDimensionalArrayMutableConstField)
+        @testset "`BoxConstField`" begin
+            @test @isdefined BoxConstField
+            @test ismutabletype(BoxConstField)
         end
     end
 end