Skip to content

Commit bef0dbe

Browse files
committed
clarify in obserrve state that you can give any state vector
1 parent 56f83e2 commit bef0dbe

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "DynamicalSystemsBase"
22
uuid = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
33
repo = "https://github.com/JuliaDynamics/DynamicalSystemsBase.jl.git"
4-
version = "3.5.2"
4+
version = "3.5.3"
55

66
[deps]
77
ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"

src/core/dynamicalsystem_interface.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,9 @@ See also [`initial_state`](@ref), [`observe_state`](@ref).
163163
current_state(ds::DynamicalSystem) = ds.u
164164

165165
"""
166-
observe_state(ds::DynamicalSystem, i) → x::Real
166+
observe_state(ds::DynamicalSystem, i [,u = current_state(ds)]) → x::Real
167167
168-
Return the current state of `ds` _observed_ at "index" `i`. Possibilities are:
168+
Return the state `u` of `ds` _observed_ at "index" `i`. Possibilities are:
169169
170170
- `i::Int` returns the `i`-th dynamic variable.
171171
- `i::Function` returns `f(current_state(ds))`, which is asserted to be a real number.

0 commit comments

Comments
 (0)