Skip to content

Commit 329b50e

Browse files
committed
good docstring for DynamicalSystem
1 parent 49a1846 commit 329b50e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/dynamicalsystem/dynamicalsystem.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Here is how to define them:
4949
* **iip** : The `eom` **must** be in the form `eom(x, p, t) -> SVector`
5050
which means that given a state `x::SVector` and some parameter container
5151
`p` it returns an [`SVector`](http://juliaarrays.github.io/StaticArrays.jl/stable/pages/api.html#SVector-1)
52+
(from the [StaticArrays](https://github.com/JuliaArrays/StaticArrays.jl) module)
5253
containing the next state.
5354
* **oop** : The `eom` **must** be in the form `eom!(xnew, x, p, t)`
5455
which means that given a state `x::Vector` and some parameter container `p`,
@@ -65,9 +66,9 @@ possible however to deduce whether the system is continuous or discrete just fro
6566
equations of motion, hence the 2 constructors.
6667
6768
### Jacobian
68-
The final optional argument (`jacobian`) for the constructors
69+
The optional argument `jacobian` for the constructors
6970
is a *function* and (if given) must also be of the same form as the `eom`,
70-
`jacobian(x, p, n) -> [SMatrix](http://juliaarrays.github.io/StaticArrays.jl/stable/pages/api.html#SMatrix-1)`
71+
`jacobian(x, p, n) -> SMatrix`
7172
for the out-of-place version and `jacobian!(xnew, x, p, n)` for the in-place version.
7273
7374
If `jacobian` is not given, it is constructed automatically using
@@ -85,7 +86,7 @@ sol = solve(ds.prob, alg; kwargs...)
8586
```
8687
8788
## Relevant Functions
88-
[`state`](@ref), [`trajectory`](@ref), [`jacobian`](@ref), [`dimension`](@ref),
89+
[`trajectory`](@ref), [`jacobian`](@ref), [`dimension`](@ref),
8990
[`set_parameter!`](@ref).
9091
"""
9192
abstract type DynamicalSystem{

0 commit comments

Comments
 (0)