RecursiveArrayTools.jl
RecursiveArrayTools.jl copied to clipboard
Docs: usage of j vs i
Currently the documentation for VectorOfArray states:
A[i] # Returns the ith array in the vector of arrays
A[j, i] # Returns the jth component in the ith array
A[j1, ..., jN, i] # Returns the (j1,...,jN) component of the ith array
Followed by this sentence:
"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."
I think the choice of i
is pretty confusing in this sentence as j
is used before to represent the component index. For consistency I propose using j
:
"Also, vecarr_to_vectors(VA::AbstractVectorOfArray)
returns a vector of the series for each component, that is, A[j,:]
for each j
. A plot recipe is provided, which plots the A[j,:]
series."