SciML / SciML/RecursiveArrayTools.jl

Choice of memory layout for VectorOfArray

Open
#256 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
233
Forks
76
Avg merge
2h 17m
Merged PRs (30d)
9

Description

From the docs:

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

which presents itself as a column-major matrix with the columns being the arrays from the vector.

What is the reasoning behind this memory layout? Can one use a tranposed memory layout, i.e. each component is represented by a column? What are the performance implications when trying to access A[j1, :] for max(i) >> max(j), i.e. timeseries data?

Perhaps the answers to those questions should be included in the docs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the VectorOfArray indexing documentation and the surrounding implementation to determine how its current memory layout is represented. Document the rationale, compare the proposed transposed layout, and explain the performance implications for time-series access; the issue names no specific file or test to run.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation, performance
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.