deprecate vecarr_to_arr

Author: ChrisRackauckas

README.md

@@ -34,7 +34,7 @@ which act appropriate. Points to note are:
 - The length is the number of vectors, or `length(A.u)` where `u` is the vector of arrays.
 - Iteration follows the linear index and goes over the vectors
 
-Additionally, the `vecarr_to_arr(VA::AbstractVectorOfArray)` function is provided which transforms
+Additionally, the `convert(Array,VA::AbstractVectorOfArray)` function is provided which transforms
 the `VectorOfArray` into a matrix/tensor. Also, `vecarr_to_vectors(VA::AbstractVectorOfArray)`
 returns a vector of the series for each component, that is `A[i,:]` for each `i`.
 A plot recipe is provided which plots the `A[i,:]` series.
@@ -86,11 +86,14 @@ A recursive `copy!` function. Acts like a `deepcopy!` on arrays of arrays, but
 like `copy!` on arrays of scalars.
 
 ```julia
-vecarr_to_arr(vecvec)
+convert(Array,vecvec)
 ```
 
-Takes in a vector of arrays, returns an array of dimension one greater than the
-original elements. Works on `AbstractVectorOfArray`.
+Technically just a Base fallback that works well. Takes in a vector of arrays,
+returns an array of dimension one greater than the original elements.
+Works on `AbstractVectorOfArray`. If the `vecvec` is ragged, i.e. not all of the
+elements are the same, then it uses the size of the first element to determine
+the conversion.
 
 ```julia
 vecvecapply(f::Base.Callable,v)

src/vector_of_array.jl

@@ -52,8 +52,8 @@ function Base.append!{T, N}(VA::AbstractVectorOfArray{T, N}, new_item::AbstractV
 end
 
 # conversion tools
-vecarr_to_arr(VA::AbstractVectorOfArray) = cat(length(size(VA)), VA.u...)
-vecarr_to_arr{T<:AbstractArray}(VA::Vector{T}) = cat(length(size(VA[1]))+1,VA...)
+@deprecate vecarr_to_arr(VA::AbstractVectorOfArray) convert(Array,VA)
+@deprecate vecarr_to_arr{T<:AbstractArray}(VA::Vector{T}) convert(Array,VA)
 vecarr_to_vectors(VA::AbstractVectorOfArray) = [VA[i,:] for i in eachindex(VA[1])]
 
 # make it show just like its data
@@ -76,10 +76,10 @@ end
 
 # plot recipes
 @recipe function f(VA::AbstractVectorOfArray)
-  vecarr_to_vectors(VA)
+  convert(Array,VA)
 end
 @recipe function f(VA::AbstractDiffEqArray)
-  A = vecarr_to_vectors(VA)
+  A = convert(Array,VA)
   VA.t,A
 end
 

test/interface_tests.jl

@@ -1,3 +1,4 @@
+using RecursiveArrayTools, Base.Test
 
 recs = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
 testva = VectorOfArray(recs)
@@ -36,8 +37,8 @@ testva[4, 9] # == testva.data[9][4]
 recs = [rand(10, 7) for i = 1:8]
 testva = VectorOfArray(recs)
 testa = cat(3, recs...)
-@test vecarr_to_arr(testva) == testa
+@test convert(Array,testva) == testa
 
 recs = [[1, 2, 3], [3 5; 6 7], [8, 9, 10, 11]]
 testva = VectorOfArray(recs)
-@test_throws DimensionMismatch vecarr_to_arr(testva)
+@test size(convert(Array,testva)) == (3,3)