Skip to content

Add ragged arrays documentation and README section#562

Merged
ChrisRackauckas merged 2 commits intoSciML:masterfrom
ChrisRackauckas-Claude:add-ragged-array-docs
Apr 1, 2026
Merged

Add ragged arrays documentation and README section#562
ChrisRackauckas merged 2 commits intoSciML:masterfrom
ChrisRackauckas-Claude:add-ragged-array-docs

Conversation

@ChrisRackauckas-Claude
Copy link
Copy Markdown
Contributor

Summary

  • Add a dedicated docs page (ragged_arrays.md) covering both ragged array approaches:
    • VectorOfArray with zero-padded rectangular interpretation (main package)
    • RaggedVectorOfArray / RaggedDiffEqArray for true ragged structure (RecursiveArrayToolsRaggedArrays subpackage)
  • Add a ragged arrays example to the README
  • Wire the new page into the docs navigation via pages.jl

The docs page includes:

  • Construction and indexing examples for both approaches
  • RaggedEnd / RaggedRange usage for type-stable end indexing on ragged dimensions
  • Multi-dimensional inner arrays, push! making arrays ragged
  • RaggedDiffEqArray for time-series with variable state dimension
  • Comparison table between the two approaches
  • API reference for AbstractRaggedVectorOfArray and AbstractRaggedDiffEqArray

Test plan

  • Verify docs build passes in CI
  • Review rendered docs page for accuracy

🤖 Generated with Claude Code

ChrisRackauckas and others added 2 commits April 1, 2026 12:17
Add a dedicated docs page covering both ragged array approaches:
- VectorOfArray with zero-padded rectangular interpretation
- RaggedVectorOfArray/RaggedDiffEqArray for true ragged structure
Include comparison table, indexing examples, RaggedEnd usage, and API reference.
Also add a ragged arrays example to the README.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Follows the same structure as the other subpackage READMEs. Covers
RaggedVectorOfArray/RaggedDiffEqArray construction, indexing, RaggedEnd
usage, and comparison table with VectorOfArray.

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ChrisRackauckas ChrisRackauckas merged commit 8b6a168 into SciML:master Apr 1, 2026
19 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants