Skip to content

Commit dd71d23

Browse files
committed
add docs
1 parent fe37286 commit dd71d23

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/src/systems/DiscreteSystem.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# DiscreteSystem
2+
3+
## System Constructors
4+
5+
```@docs
6+
DiscreteSystem
7+
```
8+
9+
## Composition and Accessor Functions
10+
11+
- `get_eqs(sys)` or `equations(sys)`: The equations that define the discrete system.
12+
- `get_unknowns(sys)` or `unknowns(sys)`: The set of unknowns in the discrete system.
13+
- `get_ps(sys)` or `parameters(sys)`: The parameters of the discrete system.
14+
- `get_iv(sys)`: The independent variable of the discrete system.
15+
- `discrete_events(sys)`: The set of discrete events in the discrete system.
16+
17+
## Transformations
18+
19+
```@docs; canonical=false
20+
structural_simplify
21+
```
22+
23+
## Problem Constructors
24+
25+
```@docs; canonical=false
26+
DiscreteProblem(sys::DiscreteSystem, u0map, tspan)
27+
DiscreteFunction(sys::DiscreteSystem, u0map, tspan)
28+
```

0 commit comments

Comments
 (0)