Merge pull request #20 from DhairyaLGandhi/dg/abstract

Check for existing constructor when dealing with Arrays

Author: ChrisRackauckas

Project.toml

@@ -4,8 +4,10 @@ authors = ["SciML"]
 version = "1.2.0"
 
 [deps]
+ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
 
 [compat]
+ArrayInterface = "7.11"
 Aqua = "0.8"
 SafeTestsets = "0.1"
 Test = "1.10"

src/SciMLStructures.jl

@@ -1,5 +1,7 @@
 module SciMLStructures
 
+using ArrayInterface: has_trivial_array_constructor
+
 include("interface.jl")
 include("array.jl")
 

src/array.jl

@@ -1,23 +1,30 @@
-hasportion(::Tunable, ::Array) = true
-hasportion(::Constants, ::Array) = false
-hasportion(::Caches, ::Array) = false
-hasportion(::Discrete, ::Array) = false
+hasportion(::Tunable, ::AbstractArray) = true
+hasportion(::Constants, ::AbstractArray) = false
+hasportion(::Caches, ::AbstractArray) = false
+hasportion(::Discrete, ::AbstractArray) = false
 
-struct ArrayRepack{T}
+struct ArrayRepack{T, Ty}
     sz::T
+    type::Ty
 end
 function (f::ArrayRepack)(A)
     @assert length(A) == prod(f.sz)
-    reshape(A, f.sz)
+    A_ = if has_trivial_array_constructor(f.type, A)
+        convert(f.type, A)
+    else
+        error("The original type $(typeof(f.type)) does not support the SciMLStructures interface via the AbstractArray `repack` rules. No method exists to take in a regular array and construct the parent type back. Please define the SciMLStructures interface for this type.")
+    end
+    reshape(A_, f.sz)
 end
 
-canonicalize(::Tunable, p::Array) = vec(p), ArrayRepack(size(p)), true
-canonicalize(::Constants, p::Array) = nothing, nothing, nothing
-canonicalize(::Caches, p::Array) = nothing, nothing, nothing
-canonicalize(::Discrete, p::Array) = nothing, nothing, nothing
+canonicalize(::Tunable, p::AbstractArray) = vec(p), ArrayRepack(size(p), typeof(p)), true
+canonicalize(::Constants, p::AbstractArray) = nothing, nothing, nothing
+canonicalize(::Caches, p::AbstractArray) = nothing, nothing, nothing
+canonicalize(::Discrete, p::AbstractArray) = nothing, nothing, nothing
 
-isscimlstructure(::Array) = true
+isscimlstructure(::AbstractArray) = true
 
-function SciMLStructures.replace(::SciMLStructures.Tunable, arr::AbstractArray, new_arr::AbstractArray)
+function SciMLStructures.replace(
+        ::SciMLStructures.Tunable, arr::AbstractArray, new_arr::AbstractArray)
     reshape(new_arr, size(arr))
 end