Rename blockmergesort and related functions to sectormergesort (#16)

Author: ogauthe

Project.toml

@@ -1,7 +1,7 @@
 name = "GradedArrays"
 uuid = "bc96ca6e-b7c8-4bb6-888e-c93f838762c2"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.2.4"
+version = "0.3.0"
 
 [deps]
 BlockArrays = "8e7c35d0-a365-5155-bbbb-fb81a777f24e"

docs/Project.toml

@@ -5,5 +5,5 @@ Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 
 [compat]
 Documenter = "1"
-GradedArrays = "0.2"
+GradedArrays = "0.3"
 Literate = "2"

ext/GradedArraysTensorAlgebraExt/GradedArraysTensorAlgebraExt.jl

@@ -5,10 +5,10 @@ using BlockSparseArrays: BlockSparseArray, blockreshape
 using GradedArrays: GradedArray
 using GradedArrays.GradedUnitRanges:
   AbstractGradedUnitRange,
-  blockmergesortperm,
-  blocksortperm,
   flip,
   invblockperm,
+  sectormergesortperm,
+  sectorsortperm,
   unmerged_tensor_product
 using GradedArrays.SymmetrySectors: trivial
 using TensorAlgebra:
@@ -52,11 +52,11 @@ function TensorAlgebra.unmatricize(
   m::AbstractMatrix,
   blocked_axes::BlockedTuple{2,<:Any,<:Tuple{Vararg{AbstractUnitRange}}},
 )
-  # First, fuse axes to get `blockmergesortperm`.
+  # First, fuse axes to get `sectormergesortperm`.
   # Then unpermute the blocks.
   fused_axes = matricize_axes(blocked_axes)
 
-  blockperms = blocksortperm.(fused_axes)
+  blockperms = sectorsortperm.(fused_axes)
   sorted_axes = map((r, I) -> only(axes(r[I])), fused_axes, blockperms)
 
   # TODO: This is doing extra copies of the blocks,
@@ -70,7 +70,7 @@ end
 
 # Sort the blocks by sector and then merge the common sectors.
 function sectormergesort(a::AbstractArray)
-  I = blockmergesortperm.(axes(a))
+  I = sectormergesortperm.(axes(a))
   return a[I...]
 end
 end

src/GradedArrays.jl

@@ -12,9 +12,6 @@ using .GradedUnitRanges:
   GradedUnitRangeDual,
   LabelledUnitRangeDual,
   blocklabels,
-  blockmergesort,
-  blockmergesortperm,
-  blocksortperm,
   dag,
   dual,
   dual_type,
@@ -25,6 +22,9 @@ using .GradedUnitRanges:
   nondual,
   nondual_type,
   sector_type,
+  sectormergesort,
+  sectormergesortperm,
+  sectorsortperm,
   space_isequal,
   unmerged_tensor_product
 include("SymmetrySectors/SymmetrySectors.jl")

src/GradedUnitRanges/fusion.jl

@@ -36,7 +36,7 @@ function unmerged_tensor_product(a1::AbstractGradedUnitRange, a2::AbstractGraded
 end
 
 # convention: sort GradedUnitRangeDual according to nondual blocks
-function blocksortperm(a::AbstractUnitRange)
+function sectorsortperm(a::AbstractUnitRange)
   return Block.(sortperm(blocklabels(nondual(a))))
 end
 
@@ -52,14 +52,14 @@ end
 # Used by `TensorAlgebra.splitdims` in `BlockSparseArraysGradedUnitRangesExt`.
 # Get the permutation for sorting, then group by common elements.
 # groupsortperm([2, 1, 2, 3]) == [[2], [1, 3], [4]]
-function blockmergesortperm(a::AbstractUnitRange)
+function sectormergesortperm(a::AbstractUnitRange)
   return Block.(groupsortperm(blocklabels(nondual(a))))
 end
 
 # Used by `TensorAlgebra.splitdims` in `BlockSparseArraysGradedUnitRangesExt`.
 invblockperm(a::Vector{<:Block{1}}) = Block.(invperm(Int.(a)))
 
-function blockmergesort(g::AbstractGradedUnitRange)
+function sectormergesort(g::AbstractGradedUnitRange)
   glabels = blocklabels(g)
   gblocklengths = blocklengths(g)
   new_blocklengths = map(sort(unique(glabels))) do la
@@ -68,14 +68,14 @@ function blockmergesort(g::AbstractGradedUnitRange)
   return gradedrange(new_blocklengths)
 end
 
-blockmergesort(g::GradedUnitRangeDual) = flip(blockmergesort(flip(g)))
-blockmergesort(g::AbstractUnitRange) = g
+sectormergesort(g::GradedUnitRangeDual) = flip(sectormergesort(flip(g)))
+sectormergesort(g::AbstractUnitRange) = g
 
 # tensor_product produces a sorted, non-dual GradedUnitRange
-TensorProducts.tensor_product(g::AbstractGradedUnitRange) = blockmergesort(flip_dual(g))
+TensorProducts.tensor_product(g::AbstractGradedUnitRange) = sectormergesort(flip_dual(g))
 
 function TensorProducts.tensor_product(
   g1::AbstractGradedUnitRange, g2::AbstractGradedUnitRange
 )
-  return blockmergesort(unmerged_tensor_product(g1, g2))
+  return sectormergesort(unmerged_tensor_product(g1, g2))
 end

test/Project.toml

@@ -17,7 +17,7 @@ TestExtras = "5ed8adda-3752-4e41-b88a-e8b09835ee3a"
 Aqua = "0.8.11"
 BlockArrays = "1.6.0"
 BlockSparseArrays = "0.4.2"
-GradedArrays = "0.2.0"
+GradedArrays = "0.3.0"
 LinearAlgebra = "1.10.0"
 Random = "1.10.0"
 SafeTestsets = "0.1.0"

test/test_gradedunitranges_dual.jl

@@ -18,8 +18,6 @@ using GradedArrays:
   GradedUnitRangeDual,
   LabelledUnitRangeDual,
   blocklabels,
-  blockmergesortperm,
-  blocksortperm,
   dag,
   dual,
   dual_type,
@@ -28,8 +26,10 @@ using GradedArrays:
   isdual,
   nondual,
   nondual_type,
-  space_isequal,
-  sector_type
+  sector_type,
+  sectormergesortperm,
+  sectorsortperm,
+  space_isequal
 using GradedArrays.LabelledNumbers:
   LabelledInteger, LabelledUnitRange, label, label_type, labelled, labelled_isequal, unlabel
 using Test: @test, @test_broken, @testset
@@ -233,12 +233,12 @@ end
     @test label(ad[[Block(2), Block(1)]][Block(1)]) == U1(-1)
     @test ad[[Block(2)[1:2], Block(1)[1:2]]][Block(1)] == 3:4
     @test label(ad[[Block(2)[1:2], Block(1)[1:2]]][Block(1)]) == U1(-1)
-    @test blocksortperm(a) == [Block(1), Block(2)]
-    @test blocksortperm(ad) == [Block(1), Block(2)]
-    @test blocklength(blockmergesortperm(a)) == 2
-    @test blocklength(blockmergesortperm(ad)) == 2
-    @test blockmergesortperm(a) == [Block(1), Block(2)]
-    @test blockmergesortperm(ad) == [Block(1), Block(2)]
+    @test sectorsortperm(a) == [Block(1), Block(2)]
+    @test sectorsortperm(ad) == [Block(1), Block(2)]
+    @test blocklength(sectormergesortperm(a)) == 2
+    @test blocklength(sectormergesortperm(ad)) == 2
+    @test sectormergesortperm(a) == [Block(1), Block(2)]
+    @test sectormergesortperm(ad) == [Block(1), Block(2)]
 
     @test isdual(ad[Block(1)])
     @test isdual(ad[Block(1)[1:1]])