Replace @wrappedtype with a more comprehensive @array_aliases (#4)

Author: mtfishman

Project.toml

@@ -1,7 +1,7 @@
 name = "Derive"
 uuid = "a07dfc7f-7d04-4eb5-84cc-a97f051f655a"
 authors = ["ITensor developers <[email protected]> and contributors"]
-version = "0.1.0"
+version = "0.2.0"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

README.md

@@ -47,7 +47,7 @@ julia> Pkg.add("Derive")
 ## Examples
 
 ````julia
-using Derive: Derive, @derive, @interface, interface
+using Derive: Derive, @array_aliases, @derive, @interface, interface
 using Test: @test
 ````
 
@@ -109,12 +109,18 @@ function setunstoredindex!(a::SparseArrayDOK, value, I::Int...)
 end
 ````
 
-Speficy the interface the type adheres to.
+Specify the interface the type adheres to.
 
 ````julia
 Derive.interface(::Type{<:SparseArrayDOK}) = SparseArrayInterface()
 ````
 
+Define aliases like `SparseMatrixDOK`, `AnySparseArrayDOK`, etc.
+
+````julia
+@array_aliases SparseArrayDOK
+````
+
 Derive the interface for the type.
 
 ````julia
@@ -129,6 +135,9 @@ a[1, 1] = 2
 @test a[2, 1] == 0
 @test a[1, 2] == 0
 @test a[2, 2] == 0
+
+@test a isa SparseMatrixDOK
+@test a' isa AnySparseMatrixDOK
 ````
 
 Call the sparse array interface on a dense array.

examples/README.jl

@@ -52,7 +52,7 @@ julia> Pkg.add("Derive")
 
 # ## Examples
 
-using Derive: Derive, @derive, @interface, interface
+using Derive: Derive, @array_aliases, @derive, @interface, interface
 using Test: @test
 
 # Define an interface.
@@ -104,9 +104,12 @@ function setunstoredindex!(a::SparseArrayDOK, value, I::Int...)
   return a
 end
 
-# Speficy the interface the type adheres to.
+# Specify the interface the type adheres to.
 Derive.interface(::Type{<:SparseArrayDOK}) = SparseArrayInterface()
 
+# Define aliases like `SparseMatrixDOK`, `AnySparseArrayDOK`, etc.
+@array_aliases SparseArrayDOK
+
 # Derive the interface for the type.
 @derive (T=SparseArrayDOK,) begin
   Base.getindex(::T, ::Int...)
@@ -120,6 +123,9 @@ a[1, 1] = 2
 @test a[1, 2] == 0
 @test a[2, 2] == 0
 
+@test a isa SparseMatrixDOK
+@test a' isa AnySparseMatrixDOK
+
 # Call the sparse array interface on a dense array.
 isstored(a::AbstractArray, I::Int...) = true
 getstoredindex(a::AbstractArray, I::Int...) = getindex(a, I...)

src/abstractinterface.jl

@@ -8,7 +8,7 @@ interface(::Type) = error("Interface unknown.")
 function combine_interfaces(x1, x2, x_rest...)
   return combine_interfaces(combine_interfaces(x1, x2), x_rest...)
 end
-combine_interfaces(x1, x2) = comine_interface_rule(interface(x1), interface(x2))
+combine_interfaces(x1, x2) = combine_interface_rule(interface(x1), interface(x2))
 combine_interfaces(x) = interface(x)
 
 # Rules for combining interfaces.

src/wrappedarrays.jl

@@ -1,14 +1,57 @@
-using Adapt: WrappedArray
+function symbol_replace(symbol::Symbol, replacement::Pair{Symbol,Symbol})
+  return Symbol(replace(String(symbol), String(replacement[1]) => String(replacement[2])))
+end
+function symbol_cat(symbol1::Symbol, symbol2::Symbol)
+  return Symbol(symbol1, symbol2)
+end
+
+vectype(type::Symbol) = symbol_replace(type, :Array => :Vector)
+mattype(type::Symbol) = symbol_replace(type, :Array => :Matrix)
+vecormattype(type::Symbol) = symbol_replace(type, :Array => :VecOrMat)
+anytype(type::Symbol) = symbol_cat(:Any, type)
+wrappedtype(type::Symbol) = symbol_cat(:Wrapped, type)
+
+macro vecmat_aliases(type)
+  return esc(vecmat_aliases(type))
+end
+
+function vecmat_aliases(type::Symbol)
+  return quote
+    const $(vectype(type)){T} = $type{T,1}
+    const $(mattype(type)){T} = $type{T,2}
+    const $(vecormattype(type)){T} = Union{$(vectype(type)){T},$(mattype(type)){T}}
+  end
+end
 
-macro wrappedtype(type)
-  return esc(wrappedtype(type))
+using Adapt: Adapt, WrappedArray
+
+# TODO: Define for types that are hardcoded to vector or matrix,
+# i.e. `Adjoint`, Transpose`, `Diagonal`, etc. Maybe call it
+# `wrapped_vec_aliases` and `wrapped_mat_aliases`.
+macro wrapped_aliases(type)
+  return esc(wrapped_aliases(type))
 end
 
-function wrappedtype(type::Symbol)
-  wrappedtype = Symbol(:Wrapped, type)
-  anytype = Symbol(:Any, type)
+function wrapped_aliases(type::Symbol)
   return quote
-    const $wrappedtype{T,N} = $WrappedArray{T,N,$type,$type{T,N}}
-    const $anytype{T,N} = Union{$type{T,N},$wrappedtype{T,N}}
+    const $(wrappedtype(type)){T,N} = $(GlobalRef(Adapt, :WrappedArray)){
+      T,N,$type,$type{T,N}
+    }
+    const $(anytype(type)){T,N} = Union{$type{T,N},$(wrappedtype(type)){T,N}}
   end
 end
+
+macro array_aliases(type)
+  return esc(array_aliases(type))
+end
+
+function array_aliases(type::Symbol)
+  # TODO: I tried to implement this by using `quote` and calling
+  # out to the macros but I couldn't get it to work with `GlobalRef`.
+  return Expr(
+    :block,
+    vecmat_aliases(type).args...,
+    wrapped_aliases(type).args...,
+    vecmat_aliases(anytype(type)).args...,
+  )
+end