Skip to content

Commit 88c3910

Browse files
committed
minor docstring changes
1 parent 7a37784 commit 88c3910

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/discrete.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ end
2424

2525
"""
2626
DiscreteProblem(u0, eom, p = nothing) <: DynamicalSystem
27-
Fundamental structure describing a discrete dynamical law. Functions similarly
28-
with [`ODEProblem`](@ref).
27+
Fundamental structure describing a discrete dynamical law.
2928
3029
## Fields
3130
* `u0` : Initial state.
@@ -249,7 +248,7 @@ end
249248
# Parallel Evolvers #
250249
#####################################################################################
251250
"""
252-
ParallelEvolver(prob::DiscreteProblem, states) -> `pe`
251+
ParallelEvolver(prob::DiscreteProblem, states) -> pe
253252
Return a structure `pe` that evolves in parallel many `states`
254253
according to the same equations of motion.
255254
The `states` must be a `Vector` of `Vector` or `SVector`.
@@ -372,7 +371,8 @@ ws = evolve!(ws, tangentevolver, N)
372371
to evolve both ``u`` as well as ``w`` for `N` steps. It is necessary
373372
to use the syntax `ws = ...` to be able to evolve any number of ``w``
374373
(which are columns of the matrix `ws`)
375-
for both the in-place and out-of-place versions.
374+
for both the in-place and out-of-place versions. (it is not actually necessary to
375+
write `ws = ` for the in-place version)
376376
377377
For out-of-place version `ws` should be an `SMatrix`, wheras for the out-of-place
378378
version it only has to be `<:AbstractMatrix.`
@@ -396,7 +396,7 @@ independent of the state of the underlying [`DiscreteProblem`](@ref).
396396
For the in-place version only, the `TangentEvolver` must be "reset"
397397
to a given `k::Int` in order to evolve a different amount of `ws`. By default
398398
the amount of `ws` (which are stored as a matrix) coincide with the dimension of
399-
the system `D`, but any number `k ≤ D` can be evolved (all in "parallel").
399+
the system `D`, but any number `k ≤ D` can be evolved (all in parallel).
400400
401401
Use `reform!(tangentevolver, k::Int, reset_state = true)` to reform the evolver.
402402
By default the function also resets the state to the state of the `DiscreteProblem`.
@@ -493,7 +493,7 @@ set_state!(pe::TangentEvolver{false}, x) = (pe.state = x)
493493
Evolve the `te.state` and and the tangent vectors `ws` for `N` steps.
494494
495495
The function **must** be called as `ws = evolve!(ws, te, N)` in the out-of-place
496-
version.
496+
version. See [`reform!`](@ref) to evolve different amount of deviation vectors.
497497
"""
498498
function evolve!(ws, te::TangentEvolver{true, false}, N::Int = 1)
499499
# iip with user jacobian

0 commit comments

Comments
 (0)