Check shapes in NamedDimsArray constructor (#42)

Author: mtfishman

Project.toml

@@ -1,11 +1,12 @@
 name = "NamedDimsArrays"
 uuid = "60cbd0c0-df58-4cb7-918c-6f5607b73fde"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.4.4"
+version = "0.4.5"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
 ArrayLayouts = "4c555306-a7a7-4459-81d9-ec55ddd5c99a"
+Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
 DerivableInterfaces = "6c5e35bf-e59e-4898-b73c-732dcc4ba65f"
 FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
@@ -27,6 +28,7 @@ NamedDimsArraysGradedUnitRangesExt = "GradedUnitRanges"
 Adapt = "4.1.1"
 ArrayLayouts = "1.11.0"
 BlockArrays = "1.3.0"
+Compat = "4.16.0"
 DerivableInterfaces = "0.3.7"
 FillArrays = "1.13.0"
 GradedUnitRanges = "0.1.3"

src/NamedDimsArrays.jl

@@ -1,6 +1,8 @@
 module NamedDimsArrays
 
 export NamedDimsArray, aligndims, named, nameddimsarray
+using Compat: @compat
+@compat public to_nameddimsindices
 
 include("isnamed.jl")
 include("randname.jl")

src/abstractnameddimsarray.jl

@@ -59,7 +59,12 @@ function to_nameddimsindices(a::AbstractArray, dims)
   return to_nameddimsindices(a, axes(a), dims)
 end
 function to_nameddimsindices(a::AbstractArray, axes, dims)
-  return map((axis, dim) -> to_dimname(a, axis, dim), axes, dims)
+  length(axes) == length(dims) || error("Number of dimensions don't match.")
+  nameddimsindices = map((axis, dim) -> to_dimname(a, axis, dim), axes, dims)
+  if any(size(a) .≠ length.(dename.(nameddimsindices)))
+    error("Input dimensions don't match.")
+  end
+  return nameddimsindices
 end
 function to_dimname(a::AbstractArray, axis, dim::AbstractNamedArray)
   # TODO: Check `axis` and `dim` have the same shape?

src/nameddimsarray.jl

@@ -6,6 +6,7 @@ struct NamedDimsArray{T,N,Parent<:AbstractArray{T,N},DimNames} <:
   parent::Parent
   nameddimsindices::DimNames
   function NamedDimsArray(parent::AbstractArray, dims)
+    # This checks the shapes of the inputs.
     nameddimsindices = to_nameddimsindices(parent, dims)
     return new{eltype(parent),ndims(parent),typeof(parent),typeof(nameddimsindices)}(
       parent, nameddimsindices

test/test_basics.jl

@@ -68,8 +68,14 @@ using Test: @test, @test_throws, @testset
     @test dims(na, ("j", "i")) == (2, 1)
     @test na[1, 1] == a[1, 1]
 
+    @test_throws ErrorException NamedDimsArray(randn(4), namedoneto.((2, 2), ("i", "j")))
+    @test_throws ErrorException NamedDimsArray(randn(2, 2), namedoneto.((2, 3), ("i", "j")))
+
     a = randn(elt, 3, 4)
     na = nameddimsarray(a, ("i", "j"))
+    i = namedoneto(3, "i")
+    j = namedoneto(4, "j")
+    ai, aj = axes(na)
     for na′ in (
       similar(na, Float32, (j, i)),
       similar(na, Float32, NaiveOrderedSet((j, i))),
@@ -87,6 +93,9 @@ using Test: @test, @test_throws, @testset
 
     a = randn(elt, 3, 4)
     na = nameddimsarray(a, ("i", "j"))
+    i = namedoneto(3, "i")
+    j = namedoneto(4, "j")
+    ai, aj = axes(na)
     for na′ in (
       similar(na, (j, i)),
       similar(na, NaiveOrderedSet((j, i))),

test/test_exports.jl

@@ -2,5 +2,9 @@ using NamedDimsArrays: NamedDimsArrays
 using Test: @test, @testset
 @testset "Test exports" begin
   exports = [:NamedDimsArrays, :NamedDimsArray, :aligndims, :named, :nameddimsarray]
+  publics = [:to_nameddimsindices]
+  if VERSION ≥ v"1.11-"
+    exports = [exports; publics]
+  end
   @test issetequal(names(NamedDimsArrays), exports)
 end