rename BoxConstField to BoxConst (#18)

Author: nsajko

README.md

@@ -17,7 +17,7 @@ Exports these zero-dimensional subtypes of `AbstractArray`, differing on topics
     * declared with `mutable struct`
     * supports `setfield!` for mutating the element
     * acts as a reference to its element
-* `BoxConstField`
+* `BoxConst`
     * declared with `mutable struct`
     * does not support `setfield!`, or mutating the element otherwise
     * acts as a reference to its element
@@ -48,7 +48,7 @@ The motivation for creating this package is:
     * previous discussion:
         * https://github.com/JuliaLang/julia/issues/40369
         * https://discourse.julialang.org/t/dynamic-immutable-type/127168
-* To provide a [*boxing*](https://en.wikipedia.org/wiki/Boxing_(computer_programming)) feature, for example for data deduplication to avoid excessive memory use. Either `Box` or `BoxConstField` might be a good choice here, depending on whether mutability is desired. Compare:
+* To provide a [*boxing*](https://en.wikipedia.org/wiki/Boxing_(computer_programming)) feature, for example for data deduplication to avoid excessive memory use. Either `Box` or `BoxConst` might be a good choice here, depending on whether mutability is desired. Compare:
     * ```julia-repl
       julia> large_data = ntuple(identity, 8)
       (1, 2, 3, 4, 5, 6, 7, 8)
@@ -87,7 +87,7 @@ The motivation for creating this package is:
        0
        0
       ```
-      The other types, `Box` or `BoxConstField` would work for this use case, too, as would any zero-dimensional array, but `ZeroDimArray` is more likely to have zero cost for performance.
+      The other types, `Box` or `BoxConst` would work for this use case, too, as would any zero-dimensional array, but `ZeroDimArray` is more likely to have zero cost for performance.
     * previous discussion regarding `Ref`:
         * https://discourse.julialang.org/t/ref-vs-zero-dimensional-arrays/24434
 

src/ZeroDimensionalArrays.jl

@@ -3,7 +3,7 @@ module ZeroDimensionalArrays
 export
     ZeroDimArray,
     Box,
-    BoxConstField
+    BoxConst
 
 struct ZeroDimArray{T} <: AbstractArray{T, 0}
     v::T
@@ -22,7 +22,7 @@ mutable struct Box{T} <: AbstractArray{T, 0}
     end
 end
 
-mutable struct BoxConstField{T} <: AbstractArray{T, 0}
+mutable struct BoxConst{T} <: AbstractArray{T, 0}
     const v::T
     global function new_zero_dimensional_array_mutable_const_field(::Type{T}, v) where {T}
         new{T}(v)
@@ -32,15 +32,15 @@ end
 const ZeroDimensionalArray = Union{
     ZeroDimArray,
     Box,
-    BoxConstField,
+    BoxConst,
 }
 
 function type_to_constructor_function(::Type{T}) where {T <: ZeroDimensionalArray}
     if T <: ZeroDimArray
         new_zero_dimensional_array_immutable
     elseif T <: Box
         new_zero_dimensional_array_mutable
-    elseif T <: BoxConstField
+    elseif T <: BoxConst
         new_zero_dimensional_array_mutable_const_field
     else
         throw(ArgumentError("no such constructor function"))
@@ -102,7 +102,7 @@ end
 for Arr ∈ (
     ZeroDimArray,
     Box,
-    BoxConstField,
+    BoxConst,
 )
     @eval begin
         function Base.convert(::Type{$Arr}, a::AbstractArray{<:Any, 0})

test/runtests.jl

@@ -11,7 +11,7 @@ using Aqua: Aqua
         for Arr ∈ (
             ZeroDimArray,
             Box,
-            BoxConstField,
+            BoxConst,
         )
             @test (@inferred Arr(0.3)) == (@inferred convert(Arr, fill(0.3)))
             @test isstructtype(Arr)
@@ -51,9 +51,9 @@ using Aqua: Aqua
                 only(a) === 0.7
             end
         end
-        @testset "`BoxConstField`" begin
-            @test @isdefined BoxConstField
-            @test ismutabletype(BoxConstField)
+        @testset "`BoxConst`" begin
+            @test @isdefined BoxConst
+            @test ismutabletype(BoxConst)
         end
     end
 end