Refactor similar

Author: mtfishman

src/abstractsparsearray.jl

@@ -15,14 +15,33 @@ function Base.copy(a::AnyAbstractSparseArray)
   return copyto!(similar(a), a)
 end
 
+function similar_sparsearray(a::AnyAbstractSparseArray, unstored::Unstored)
+  return SparseArrayDOK(unstored)
+end
+function similar_sparsearray(a::AnyAbstractSparseArray, T::Type, ax::Tuple)
+  return similar_sparsearray(a, Unstored(unstoredsimilar(unstored(a), T, ax)))
+end
+function similar_sparsearray(a::AnyAbstractSparseArray, T::Type)
+  return similar_sparsearray(a, Unstored(unstoredsimilar(unstored(a), T)))
+end
+function similar_sparsearray(a::AnyAbstractSparseArray, ax::Tuple)
+  return similar_sparsearray(a, Unstored(unstoredsimilar(unstored(a), ax)))
+end
+function similar_sparsearray(a::AnyAbstractSparseArray)
+  return similar_sparsearray(a, Unstored(unstored(a)))
+end
+
+function Base.similar(a::AnyAbstractSparseArray, unstored::Unstored)
+  return similar_sparsearray(a, unstored)
+end
 function Base.similar(a::AnyAbstractSparseArray)
-  return SparseArrayDOK(Unstored(unstored(a)))
+  return similar_sparsearray(a)
 end
 function Base.similar(a::AnyAbstractSparseArray, T::Type)
-  return SparseArrayDOK(Unstored(unstoredsimilar(unstored(a), T)))
+  return similar_sparsearray(a, T)
 end
 function Base.similar(a::AnyAbstractSparseArray, ax::Tuple)
-  return similar(a, eltype(a), ax)
+  return similar_sparsearray(a, ax)
 end
 function Base.similar(a::AnyAbstractSparseArray, T::Type, ax::Tuple)
   return similar_sparsearray(a, T, ax)
@@ -39,9 +58,6 @@ function Base.similar(
 )
   return similar_sparsearray(a, T, ax)
 end
-function similar_sparsearray(a::AnyAbstractSparseArray, T::Type, ax::Tuple)
-  return SparseArrayDOK(Unstored(unstoredsimilar(unstored(a), T, ax)))
-end
 
 using DerivableInterfaces: @derive
 

src/map.jl

@@ -79,8 +79,11 @@ function map_sparsearray(f::ZeroPreserving, A::AbstractArray, Bs::AbstractArray.
   T = Base.Broadcast.combine_eltypes(f.f, (A, Bs...))
   C = similar(A, T)
   # TODO: Instead use:
+  # ```julia
   # U = map(f.f, map(unstored, (A, Bs...))...)
   # C = similar(A, Unstored(U))
+  # ```
+  # though right now `map` doesn't preserve `Zeros` or `BlockZeros`.
   return map_sparsearray!(f, C, A, Bs...)
 end