Skip to content

Commit fc53824

Browse files
committed
add Prev and Next to docs
1 parent a6c852b commit fc53824

File tree

4 files changed

+26
-3
lines changed

4 files changed

+26
-3
lines changed

docs/src/systems/DiscreteSystem.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,10 @@ structural_simplify
2626
DiscreteProblem(sys::DiscreteSystem, u0map, tspan)
2727
DiscreteFunction(sys::DiscreteSystem, args...)
2828
```
29+
30+
## Discrete Domain
31+
```@docs; canonical=false
32+
Shift
33+
Prev
34+
Next
35+
```

docs/src/systems/ImplicitDiscreteSystem.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,10 @@ structural_simplify
2626
ImplicitDiscreteProblem(sys::ImplicitDiscreteSystem, u0map, tspan)
2727
ImplicitDiscreteFunction(sys::ImplicitDiscreteSystem, args...)
2828
```
29+
30+
## Discrete Domain
31+
```@docs; canonical=false
32+
Shift
33+
Prev
34+
Next
35+
```

docs/src/tutorials/SampledData.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ The operators [`Sample`](@ref) and [`Hold`](@ref) are thus providing the interfa
2525
The [`ShiftIndex`](@ref) operator is used to refer to past and future values of discrete-time variables. The example below illustrates its use, implementing the discrete-time system
2626

2727
```math
28-
x(k+1) = 0.5x(k) + u(k)
29-
y(k) = x(k)
28+
\begin{align}
29+
x(k+1) &= 0.5x(k) + u(k) \\
30+
y(k) &= x(k)
31+
\end{align}
3032
```
3133

3234
```@example clocks
@@ -187,3 +189,10 @@ connections = [r ~ sin(t) # reference signal
187189
188190
@named cl = ODESystem(connections, t, systems = [f, c, p])
189191
```
192+
193+
```@docs
194+
Sample
195+
Hold
196+
ShiftIndex
197+
Clock
198+
```

src/ModelingToolkit.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ export debug_system
301301
#export ContinuousClock, Discrete, sampletime, input_timedomain, output_timedomain
302302
#export has_discrete_domain, has_continuous_domain
303303
#export is_discrete_domain, is_continuous_domain, is_hybrid_domain
304-
export Sample, Hold, Shift, ShiftIndex, sampletime, SampleTime
304+
export Sample, Hold, Shift, ShiftIndex, sampletime, SampleTime, Next, Prev
305305
export Clock, SolverStepClock, TimeDomain
306306

307307
export MTKParameters, reorder_dimension_by_tunables!, reorder_dimension_by_tunables

0 commit comments

Comments
 (0)