new function get_states (#143)

* new function `get_states`

* also add test

* fix location of get_states

Author: Datseris

CHANGELOG.md

@@ -1,3 +1,5 @@
+# v2.7
+* New function `get_states` that returns an iterator over states contained in a `parallel_integrator`.
 # v2.6
 * Added new `GeneralizedDynamicalSystem` abstract type that is an umbrella term.
 # v2.5

Project.toml

@@ -1,7 +1,7 @@
 name = "DynamicalSystemsBase"
 uuid = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
 repo = "https://github.com/JuliaDynamics/DynamicalSystemsBase.jl.git"
-version = "2.6.6"
+version = "2.7.0"
 
 [deps]
 DelayEmbeddings = "5732040d-69e3-5649-938a-b6b4f237613f"

src/DynamicalSystemsBase.jl

@@ -28,7 +28,7 @@ include("predefined/famous_systems.jl") # includes both discrete and continuous
 export GeneralizedDynamicalSystem, DynamicalSystem
 export ContinuousDynamicalSystem, DiscreteDynamicalSystem
 export get_rule_for_print, isdiscretetime
-export dimension, get_state
+export dimension, get_state, get_states
 export set_parameter!, trajectory, jacobian
 export integrator, tangent_integrator, parallel_integrator
 export set_state!, get_state, get_deviations, set_deviations!, current_time

src/core/api_docstrings.jl

@@ -28,6 +28,12 @@ for tangent integrators.
 """
 get_state(integ) = integ.u
 
+"""
+    get_states(pinteg)
+Return an iterator over all contained states in a [`parallel_integrator`](@ref).
+"""
+get_states(integ) = integ.u
+
 """
     set_state!(integ, u [, i::Int = 1])
 Set the state of the integrator to `u`, in the sense of the state of the

src/core/continuous.jl

@@ -219,6 +219,9 @@ get_state(integ::AbstractODEIntegrator{Alg, IIP, S}, k::Int = 1) where {Alg, IIP
 get_state(integ::AbstractODEIntegrator{Alg, IIP, S}, k::Int = 1) where {Alg, IIP, S<:AbstractMatrix} =
     view(integ.u, :, k)
 
+get_states(integ::AbstractODEIntegrator{Alg, IIP, S}) where {Alg, IIP, S<:AbstractMatrix} =
+    eachcol(integ.u)
+
 function set_state!(
     integ::AbstractODEIntegrator{Alg, IIP, S}, u::AbstractVector
     ) where {Alg, IIP, S<:AbstractVector}

test/dynsys_integrators.jl

@@ -71,6 +71,7 @@ for i in 1:8
 
         # Test parallel integrators
         pinteg = parallel_integrator(ds, [copy(INITCOD[sysindx]), copy(INITCOD[sysindx])]; diffeq)
+        @test length(get_states(pinteg)) == 2
         puprev = deepcopy(get_state(pinteg))
         step!(pinteg)
         @test get_state(pinteg, 1) == get_state(pinteg, 2) == get_state(pinteg)