Skip to content

docs: add docstring for discretes support in AbstractDiffEqArray #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −0
Open

docs: add docstring for discretes support in AbstractDiffEqArray #441

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/RecursiveArrayTools.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
plan in 2026 to complete the deprecation and thus have a breaking update where `A[i]`
matches the linear indexing of an `AbstractArray`, and then making
`AbstractVectorOfArray <: AbstractArray`. Until then, `AbstractVectorOfArray` due to
this interface break but manaully implements an AbstractArray-like interface for

Check warning on line 39 in src/RecursiveArrayTools.jl

View workflow job for this annotation

GitHub Actions / Spell Check with Typos 

"manaully" should be "manually".
future compatability.

Check warning on line 40 in src/RecursiveArrayTools.jl

View workflow job for this annotation

GitHub Actions / Spell Check with Typos 

"compatability" should be "compatibility".

## Fields

Expand Down Expand Up @@ -126,6 +126,9 @@
An AbstractDiffEqArray adds the following fields:

* `t` which holds the times of each timestep.
* `discretes` (optional) which contains a
`SymbolicIndexingInterface.ParameterTimeseriesCollection` to allow storing and indexing
discrete variables. Indexing behavior is handled via `SymbolicIndexingInterface.getu`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a mention of symbolic indexing for DiffEqArray in a # Symbolic Array Interface section? And any other requirements you implicitly have put on DiffEqArray to make that work should get mentioned.

"""
abstract type AbstractDiffEqArray{T, N, A} <: AbstractVectorOfArray{T, N, A} end

Expand Down
Loading