WIP: make transpose non-recursive

NEWS.md

@@ -290,6 +290,14 @@ This section lists changes that do not have deprecation warnings.
     Its return value has been removed. Use the `process_running` function
     to determine if a process has already exited.
 
+  * `transpose` and `transpose!` no longer recursively transpose the elements of the
+    container. Similarly, `RowVector` no longer provides a transposed view of the elements.
+    Transposition now simply rearranges the elements of containers of data, such as arrays
+    of strings. Note that the renamed `adjoint` method (formerly `ctranspose`) does still
+    act in a recursive manner, and that (very occassionally) `conj(adjoint(...))` will be
+    preferrable to `transpose` for linear algebra problems using nested arrays as "block
+    matrices". ([#23424])
+
 Library improvements
 --------------------
 

base/abstractarraymath.jl

@@ -83,6 +83,94 @@ end
 
 squeeze(A::AbstractArray, dim::Integer) = squeeze(A, (Int(dim),))
 
+## Transposition ##
+
+"""
+    transpose(A::AbstractMatrix)
+
+The transposition operator (`.'`).
+
+# Examples
+```jldoctest
+julia> A = [1 2 3; 4 5 6; 7 8 9]
+3×3 Array{Int64,2}:
+1  2  3
+4  5  6
+7  8  9
+
+julia> transpose(A)
+3×3 Array{Int64,2}:
+1  4  7
+2  5  8
+3  6  9
+```
+"""
+function transpose(A::AbstractMatrix)
+    ind1, ind2 = indices(A)
+    B = similar(A, (ind2, ind1))
+    transpose!(B, A)
+end
+
+transpose(a::AbstractArray) = error("transpose not defined for $(typeof(a)). Consider using `permutedims` for higher-dimensional arrays.")
+
+"""
+    transpose!(dest, src)
+
+Transpose array `src` and store the result in the preallocated array `dest`, which should
+have a size corresponding to `(size(src,2),size(src,1))`. No in-place transposition is
+supported and unexpected results will happen if `src` and `dest` have overlapping memory
+regions.
+"""
+transpose!(B::AbstractMatrix, A::AbstractMatrix) = transpose_f!(identity, B, A)
+
+function transpose!(B::AbstractVector, A::AbstractMatrix)
+    indices(B,1) == indices(A,2) && indices(A,1) == 1:1 || throw(DimensionMismatch("transpose"))
+    copy!(B, A)
+end
+function transpose!(B::AbstractMatrix, A::AbstractVector)
+    indices(B,2) == indices(A,1) && indices(B,1) == 1:1 || throw(DimensionMismatch("transpose"))
+    copy!(B, A)
+end
+
+const transposebaselength=64
+function transpose_f!(f, B::AbstractMatrix, A::AbstractMatrix)
+    inds = indices(A)
+    indices(B,1) == inds[2] && indices(B,2) == inds[1] || throw(DimensionMismatch(string(f)))
+
+    m, n = length(inds[1]), length(inds[2])
+    if m*n<=4*transposebaselength
+        @inbounds begin
+            for j = inds[2]
+                for i = inds[1]
+                    B[j,i] = f(A[i,j])
+                end
+            end
+        end
+    else
+        transposeblock!(f,B,A,m,n,first(inds[1])-1,first(inds[2])-1)
+    end
+    return B
+end
+function transposeblock!(f, B::AbstractMatrix, A::AbstractMatrix, m::Int, n::Int, offseti::Int, offsetj::Int)
+    if m*n<=transposebaselength
+        @inbounds begin
+            for j = (offsetj+1):(offsetj+n)
+                for i = (offseti+1):(offseti+m)
+                    B[j,i] = f(A[i,j])
+                end
+            end
+        end
+    elseif m>n
+        newm=m>>1
+        transposeblock!(f,B,A,newm,n,offseti,offsetj)
+        transposeblock!(f,B,A,m-newm,n,offseti+newm,offsetj)
+    else
+        newn=n>>1
+        transposeblock!(f,B,A,m,newn,offseti,offsetj)
+        transposeblock!(f,B,A,m,n-newn,offseti,offsetj+newn)
+    end
+    return B
+end
 
 ## Unary operators ##
 

base/exports.jl

@@ -73,6 +73,9 @@ export
     LinSpace,
     LowerTriangular,
     Irrational,
+    MappedArray,
+    MappedVector,
+    MappedMatrix,
     Matrix,
     MergeSort,
     NTuple,

base/linalg/adjoint.jl

@@ -0,0 +1,271 @@
+# This file is a part of Julia. License is MIT: https://julialang.org/license
+
+adjoint(a::AbstractArray) = error("adjoint not defined for $(typeof(a)). Consider using `permutedims` for higher-dimensional arrays.")
+
+## adjoint ##
+
+"""
+    adjoint(v::AbstractVector)
+
+Creates a `RowVector` from `v` where `adjoint` has been applied recursively to the elements.
+Conceptually, this is intended create the "dual vector" of `v` (note however that the output
+is strictly an `AbstractMatrix`). Note also that the output is a view of `v`.
+"""
+@inline adjoint(vec::AbstractVector) = RowVector(_map(adjoint, vec))
+@inline adjoint(rowvec::RowVector) = _map(adjoint, parent(rowvec))
+
+"""
+    adjoint(m::AbstractMatrix)
+
+Returns the Hermitian adjoint of `m`, where `m` has been transposed and `adjoint` is applied
+recursively to the elements.
+
+# Examples
+```jldoctest
+julia> A =  [3+2im 9+2im; 8+7im  4+6im]
+2×2 Array{Complex{Int64},2}:
+ 3+2im  9+2im
+ 8+7im  4+6im
+
+julia> adjoint(A)
+2×2 Array{Complex{Int64},2}:
+ 3-2im  8-7im
+ 9-2im  4-6im
+```
+"""
+function adjoint(a::AbstractMatrix)
+    (ind1, ind2) = indices(a)
+    b = similar(a, promote_op(adjoint, eltype(a)), (ind2, ind1))
+    adjoint!(b, a)
+end
+
+"""
+adjoint!(dest,src)
+
+Conjugate transpose array `src` and store the result in the preallocated array `dest`, which
+should have a size corresponding to `(size(src,2),size(src,1))`. No in-place transposition
+is supported and unexpected results will happen if `src` and `dest` have overlapping memory
+regions.
+"""
+adjoint!(b::AbstractMatrix, a::AbstractMatrix) = transpose_f!(adjoint, b, a)
+function adjoint!(b::AbstractVector, a::AbstractMatrix)
+    if indices(b, 1) != indices(a, 2) || indices(a, 1) != 1:1
+        throw(DimensionMismatch("adjoint"))
+    end
+    adjointcopy!(b, a)
+end
+function adjoint!(b::AbstractMatrix, a::AbstractVector)
+    if indices(b, 2) != indices(a, 1) || indices(b, 1) != 1:1
+        throw(DimensionMismatch("adjoint"))
+    end
+    adjointcopy!(b, a)
+end
+
+function adjointcopy!(b, a)
+    ra = eachindex(a)
+    rb = eachindex(b)
+    if rb == ra
+        for i ∈ rb
+            b[i] = adjoint(a[i])
+        end
+    else
+        for (i, j) ∈ zip(rb, ra)
+            b[i] = adjoint(a[j])
+        end
+    end
+end
+
+"""
+adjoint(x::Number)
+
+The (complex) conjugate of `x`, `conj(x)`.
+"""
+adjoint(x::Number) = conj(x)
+
+
+## conjadjoint ##
+
+"""
+conjadjoint(a)
+
+Returns `conj(adjoint(a))`.
+"""
+conjadjoint(a) = conj(adjoint(a))
+conjadjoint(a::Number) = a
+
+∘(::typeof(conj), ::typeof(conj)) = identity
+∘(::typeof(adjoint), ::typeof(adjoint)) = identity
+∘(::typeof(conjadjoint), ::typeof(conjadjoint)) = identity
+
+∘(::typeof(conj), ::typeof(adjoint)) = conjadjoint
+∘(::typeof(adjoint), ::typeof(conj)) = conjadjoint
+∘(::typeof(conj), ::typeof(conjadjoint)) = adjoint
+∘(::typeof(conjadjoint), ::typeof(conj)) = adjoint
+∘(::typeof(adjoint), ::typeof(conjadjoint)) = conj
+∘(::typeof(conjadjoint), ::typeof(adjoint)) = conj
+
+## mapped array aliases ##
+
+"""
+    ConjArray(array)
+
+Constructs a lazy view of `array` where all elements are conjugated via `conj`. An alias of
+[`MappedArray`](@ref).
+"""
+const ConjArray{T,N,A<:AbstractArray{<:Any,N}} = MappedArray{T,N,typeof(conj),typeof(conj),A}
+const ConjVector{T,A<:AbstractVector} = MappedVector{T,typeof(conj),typeof(conj),A}
+const ConjMatrix{T,A<:AbstractMatrix} = MappedMatrix{T,typeof(conj),typeof(conj),A}
+
+ConjArray(a::AbstractArray) = MappedArray(conj, conj, a)
+ConjVector(v::AbstractVector) = MappedVector(conj, conj, v)
+ConjMatrix(m::AbstractMatrix) = MappedMatrix(conj, conj, m)
+
+# Unexported
+const AdjointArray{T,N,A<:AbstractArray{<:Any,N}} = MappedArray{T,N,typeof(adjoint),typeof(adjoint),A}
+const AdjointVector{T,A<:AbstractVector} = MappedVector{T,typeof(adjoint),typeof(adjoint),A}
+const AdjointMatrix{T,A<:AbstractMatrix} = MappedMatrix{T,typeof(adjoint),typeof(adjoint),A}
+
+AdjointArray(a::AbstractArray) = MappedArray(adjoint, adjoint, a)
+AdjointVector(v::AbstractVector) = MappedVector(adjoint, adjoint, v)
+AdjointMatrix(m::AbstractMatrix) = MappedMatrix(adjoint, adjoint, m)
+
+const ConjAdjointArray{T,N,A<:AbstractArray{<:Any,N}} = MappedArray{T,N,typeof(conjadjoint),typeof(conjadjoint),A}
+const ConjAdjointVector{T,A<:AbstractVector} = MappedVector{T,typeof(conjadjoint),typeof(conjadjoint),A}
+const ConjAdjointMatrix{T,A<:AbstractMatrix} = MappedMatrix{T,typeof(conjadjoint),typeof(conjadjoint),A}
+
+ConjAdjointArray(a::AbstractArray) = MappedArray(conjadjoint, conjadjoint, a)
+ConjAdjointVector(v::AbstractVector) = MappedVector(conjadjoint, conjadjoint, v)
+ConjAdjointMatrix(m::AbstractMatrix) = MappedMatrix(conjadjoint, conjadjoint, m)
+
+inv_func(::typeof(adjoint)) = adjoint
+inv_func(::typeof(conjadjoint)) = conjadjoint
+
+@inline _map(f, a::AbstractArray) = MappedArray(f, a)
+@inline _map(f, a::MappedArray) = map(f, a)
+
+# Make sure to unwrap whenever possible (ideally this would be a MappedArray thing but it is
+# a bit tricky since we can't assume `f` contains no run-time data).
+@inline _map(::typeof(conj), a::ConjArray) = parent(a)
+@inline _map(::typeof(adjoint), a::AdjointArray) = parent(a)
+@inline _map(::typeof(conjadjoint), a::ConjAdjointArray) = parent(a)
+
+# Simplify where possible
+@inline _map(::typeof(conj), a::AbstractArray{<:Real}) = a
+@inline _map(::typeof(adjoint), a::AbstractArray{<:Number}) = _map(conj, a)
+@inline _map(::typeof(conjadjoint), a::AbstractArray{<:Number}) = a
+
+# Disambiguation
+@inline _map(::typeof(conj), a::ConjArray{<:Real}) = parent(a)
+@inline _map(::typeof(adjoint), a::AdjointArray{<:Number}) = parent(a)
+@inline _map(::typeof(conjadjoint), a::ConjAdjointArray{<:Number}) = parent(a)
+
+
+## lazy conj ##
+
+"""
+conj(v::RowVector)
+
+Return a [`ConjArray`](@ref) lazy view of the input, where each element is conjugated.
+
+# Examples
+```jldoctest
+julia> v = [1+im, 1-im].'
+1×2 RowVector{Complex{Int64},Array{Complex{Int64},1}}:
+1+1im  1-1im
+
+julia> conj(v)
+1×2 RowVector{Complex{Int64},ConjArray{Complex{Int64},1,Array{Complex{Int64},1}}}:
+1-1im  1+1im
+```
+"""
+@inline conj(rowvec::RowVector) = RowVector(_map(conj, parent(rowvec)))
+
+# transpose
+
+"""
+    adjoint(A)
+
+The conjugate transposition operator (`'`).
+
+# Examples
+```jldoctest
+julia> A =  [3+2im 9+2im; 8+7im  4+6im]
+2×2 Array{Complex{Int64},2}:
+ 3+2im  9+2im
+ 8+7im  4+6im
+
+julia> adjoint(A)
+2×2 Array{Complex{Int64},2}:
+ 3-2im  8-7im
+ 9-2im  4-6im
+```
+"""
+adjoint(x) = conj(transpose(x)) # TODO delete
+conj(x) = x # TODO delete
+
+# adjoint multiply
+
+"""
+    Ac_mul_B(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``Aᴴ⋅B``.
+"""
+Ac_mul_B(a,b)  = adjoint(a)*b
+
+"""
+    A_mul_Bc(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``A⋅Bᴴ``.
+"""
+A_mul_Bc(a,b)  = a*adjoint(b)
+
+"""
+    Ac_mul_Bc(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``Aᴴ Bᴴ``.
+"""
+Ac_mul_Bc(a,b) = adjoint(a)*adjoint(b)
+
+# adjoint divide
+
+"""
+    Ac_rdiv_B(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``Aᴴ / B``.
+"""
+Ac_rdiv_B(a,b)  = adjoint(a)/b
+
+"""
+    A_rdiv_Bc(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``A / Bᴴ``.
+"""
+A_rdiv_Bc(a,b)  = a/adjoint(b)
+
+"""
+    Ac_rdiv_Bc(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``Aᴴ / Bᴴ``.
+"""
+Ac_rdiv_Bc(a,b) = adjoint(a)/adjoint(b)
+
+"""
+    Ac_ldiv_B(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``Aᴴ`` \\ ``B``.
+"""
+Ac_ldiv_B(a,b)  = adjoint(a)\b
+
+"""
+    A_ldiv_Bc(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``A`` \\ ``Bᴴ``.
+"""
+A_ldiv_Bc(a,b)  = a\adjoint(b)
+
+"""
+    Ac_ldiv_Bc(A, B)
+
+For matrices or vectors ``A`` and ``B``, calculates ``Aᴴ`` \\ ``Bᴴ``.
+"""
+Ac_ldiv_Bc(a,b) = adjoint(a)\adjoint(b)