Skip to content

Commit 46c02cf

Browse files
committed
Adding note about the independent variable restriction. Cf #1074.
1 parent 081e7b6 commit 46c02cf

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

src/systems/control/controlsystem.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ struct ControlSystem <: AbstractControlSystem
5252
eqs::Vector{Equation}
5353
"""Independent variable."""
5454
iv::Sym
55-
"""Dependent (state) variables."""
55+
"""Dependent (state) variables. Must not contain the independent variable."""
5656
states::Vector
5757
"""Control variables."""
5858
controls::Vector
59-
"""Parameter variables."""
59+
"""Parameter variables. Must not contain the independent variable."""
6060
ps::Vector
6161
observed::Vector{Equation}
6262
"""

src/systems/diffeqs/odesystem.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ struct ODESystem <: AbstractODESystem
2727
eqs::Vector{Equation}
2828
"""Independent variable."""
2929
iv::Sym
30-
"""Dependent (state) variables."""
30+
"""Dependent (state) variables. Must not contain the independent variable."""
3131
states::Vector
32-
"""Parameter variables."""
32+
"""Parameter variables. Must not contain the independent variable."""
3333
ps::Vector
3434
observed::Vector{Equation}
3535
"""

src/systems/diffeqs/sdesystem.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ struct SDESystem <: AbstractODESystem
3333
noiseeqs::AbstractArray
3434
"""Independent variable."""
3535
iv::Sym
36-
"""Dependent (state) variables."""
36+
"""Dependent (state) variables. Must not contain the independent variable."""
3737
states::Vector
38-
"""Parameter variables."""
38+
"""Parameter variables. Must not contain the independent variable."""
3939
ps::Vector
4040
observed::Vector
4141
"""

src/systems/discrete_system/discrete_system.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ struct DiscreteSystem <: AbstractSystem
2626
eqs::Vector{Equation}
2727
"""Independent variable."""
2828
iv::Sym
29-
"""Dependent (state) variables."""
29+
"""Dependent (state) variables. Must not contain the independent variable."""
3030
states::Vector
31-
"""Parameter variables."""
31+
"""Parameter variables. Must not contain the independent variable."""
3232
ps::Vector
3333
observed::Vector{Equation}
3434
"""

src/systems/jumps/jumpsystem.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ struct JumpSystem{U <: ArrayPartition} <: AbstractSystem
3333
eqs::U
3434
"""The independent variable, usually time."""
3535
iv::Any
36-
"""The dependent variables, representing the state of the system."""
36+
"""The dependent variables, representing the state of the system. Must not contain the independent variable."""
3737
states::Vector
38-
"""The parameters of the system."""
38+
"""The parameters of the system. Must not contain the independent variable."""
3939
ps::Vector
4040
observed::Vector{Equation}
4141
"""The name of the system. . These are required to have unique names."""

src/systems/reaction/reactionsystem.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,9 @@ struct ReactionSystem <: AbstractSystem
140140
eqs::Vector{Reaction}
141141
"""Independent variable (usually time)."""
142142
iv::Any
143-
"""Dependent (state) variables representing amount of each species."""
143+
"""Dependent (state) variables representing amount of each species. Must not contain the independent variable."""
144144
states::Vector
145-
"""Parameter variables."""
145+
"""Parameter variables. Must not contain the independent variable."""
146146
ps::Vector
147147
observed::Vector{Equation}
148148
"""The name of the system"""

0 commit comments

Comments
 (0)