Skip to content

Commit 9fd5e25

Browse files
committed
doc correction
1 parent a2725c2 commit 9fd5e25

File tree

4 files changed

+10
-11
lines changed

4 files changed

+10
-11
lines changed

docs/src/manual.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ We first need to construct a [`LinModel`](@ref) objet with [`setop!`](@ref) to h
6060
operating points:
6161

6262
```@example 1
63-
using ControlSystemsBase
64-
using ModelPredictiveControl
63+
using ModelPredictiveControl, ControlSystemsBase
6564
sys = [ tf(1.90, [18, 1]) tf(1.90, [18, 1]);
6665
tf(-0.74,[8, 1]) tf(0.74, [8, 1]) ]
6766
Ts = 4.0
@@ -117,11 +116,11 @@ t_data = Ts*(0:(size(y_data,2)-1))
117116
nothing # hide
118117
```
119118

120-
The [`LinMPC`](@ref) objects are also callable to provide an alternative syntax for
121-
the [`moveinput!`](@ref) method. Calling [`updatestate!`](@ref) on the `mpc` object updates
122-
its internal state for the *NEXT* control period (this is by design, see
123-
[State Estimators](@ref) for the justification). That is why the call is done at the
124-
end of the `for` loop. The same logic applies for `model`.
119+
The [`LinMPC`](@ref) objects are also callable as an alternative syntax for
120+
[`moveinput!`](@ref). Calling [`updatestate!`](@ref) on the `mpc` object updates its
121+
internal state for the *NEXT* control period (this is by design, see
122+
[State Estimators](@ref) for justifications). That is why the call is done at the end of the
123+
`for` loop. The same logic applies for `model`.
125124

126125
Lastly, we plot the closed-loop test with the `Plots` package:
127126

docs/src/public/predictive_control.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ predictions. The default [`LinMPC`](@ref) estimator is a [`SteadyKalmanFilter`](
1111
current model mismatch estimation is constant in the future (same approach than dynamic
1212
matrix control, DMC).
1313

14-
## Abstract Types
14+
## PredictiveController
1515

1616
```@docs
1717
PredictiveController

docs/src/public/sim_model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ simulators by calling [`evaloutput`](@ref) and [`updatestate!`](@ref) methods on
1111
states `x` are stored inside [`SimModel`](@ref) objects. Use [`setstate!`](@ref) method
1212
to manually modify them.
1313

14-
## Abstract Types
14+
## SimModel
1515

1616
```@docs
1717
SimModel

docs/src/public/state_estim.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ sometimes slightly more accurate.
2323

2424
The predictor form comes in handy for control applications since the estimations come after
2525
the controller computations, without introducing any additional delays. Moreover, the
26-
[`moveinput!`](@ref) method of the predictive controller does not automatically update the
26+
[`moveinput!`](@ref) method of the predictive controllers does not automatically update the
2727
estimates with [`updatestate!`](@ref). This allows applying the calculated inputs on the
2828
real plant before starting the potentially expensive estimator computations (see
2929
[Manual](@ref) for examples).
@@ -32,7 +32,7 @@ real plant before starting the potentially expensive estimator computations (see
3232
All the estimators support measured ``\mathbf{y^m}`` and unmeasured ``\mathbf{y^u}``
3333
model outputs, where ``\mathbf{y}`` refers to all of them.
3434

35-
## Abstract Types
35+
## StateEstimator
3636

3737
```@docs
3838
StateEstimator

0 commit comments

Comments
 (0)