Rename bipermutedimsopadd! to permutedimsopadd! biperm overload

Author: mtfishman

src/matricize.jl

@@ -123,41 +123,17 @@ function matricize_axes(a::AbstractArray, ndims_codomain::Val)
     return matricize_axes(FusionStyle(a), a, ndims_codomain)
 end
 
-# `bipermutedimsopadd!` / `bipermutedimsop` — bipermutation versions of
-# `permutedimsopadd!` / `permuteddims` with an element-wise op folded in.
-#
-# These are intended to become the primary overload points for downstream array
-# types that want to fold ops into a bipartitioned permutation copy (e.g., fuse
-# `conj` into the copy, or use lazy wrappers like `StridedView` with op metadata).
-# For now, `bipermutedimsopadd!` delegates to the flat-permutation `permutedimsopadd!`.
-# In a future PR, the dependency will flip so that `permutedimsopadd!` wraps
-# `bipermutedimsopadd!`.
-
-"""
-    bipermutedimsopadd!(dest, op, src, perm_codomain, perm_domain, α, β)
-
-Like `permutedimsopadd!`, but takes a bipartitioned permutation
-`(perm_codomain, perm_domain)`.
-"""
-function bipermutedimsopadd!(
-        dest::AbstractArray, op, src::AbstractArray,
-        perm_codomain, perm_domain,
-        α::Number, β::Number
-    )
-    return permutedimsopadd!(dest, op, src, (perm_codomain..., perm_domain...), α, β)
-end
-
 """
     bipermutedimsop(op, src, perm_codomain, perm_domain)
 
-Non-mutating version of `bipermutedimsopadd!`: returns
+Non-mutating version of bipermutation `permutedimsopadd!`: returns
 `op.(permutedims(src, (perm_codomain..., perm_domain...)))`. Has "maybe alias"
 semantics — the result may be a view/wrapper aliasing `src` or a fresh copy.
 """
 function bipermutedimsop(op, src::AbstractArray, perm_codomain, perm_domain)
     perm = (perm_codomain..., perm_domain...)
     dest = similar(src, map(i -> size(src, i), perm))
-    return bipermutedimsopadd!(dest, op, src, perm_codomain, perm_domain, true, false)
+    return permutedimsopadd!(dest, op, src, perm_codomain, perm_domain, true, false)
 end
 
 # Inner version takes a list of sub-permutations, overload this one if needed.

src/permutedimsadd.jl

@@ -58,6 +58,25 @@ function permutedimsopadd!(
     return dest
 end
 
+# Bipartitioned permutation overload. Intended to become a primary overload point
+# for downstream array types that want to fold ops into a bipartitioned permutation
+# copy (e.g., fuse `conj` into the copy, or use lazy wrappers like `StridedView`
+# with op metadata). For now it delegates to the flat-permutation version by
+# concatenating the perms; in a future PR the dependency will flip.
+
+"""
+    permutedimsopadd!(dest, op, src, perm_codomain, perm_domain, α, β)
+
+Like `permutedimsopadd!`, but takes a bipartitioned permutation as two tuples.
+"""
+function permutedimsopadd!(
+        dest::AbstractArray, op, src::AbstractArray,
+        perm_codomain, perm_domain,
+        α::Number, β::Number
+    )
+    return permutedimsopadd!(dest, op, src, (perm_codomain..., perm_domain...), α, β)
+end
+
 # ---------------------------------------------------------------------------- #
 # Convenience functions that lower to permutedimsopadd!
 # ---------------------------------------------------------------------------- #