Skip to content

Commit fabf0e0

Browse files
committed
doc: precision on vector dimensions
1 parent aaf7c7a commit fabf0e0

File tree

3 files changed

+22
-9
lines changed

3 files changed

+22
-9
lines changed

docs/src/public/predictive_control.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ assumes by default that the current model mismatch estimation is constant in the
1212
(same approach as dynamic matrix control, DMC).
1313

1414
!!! info
15-
The nomenclature uses capital letters for time series (and matrices) and hats for the
16-
predictions (and estimations, for state estimators).
15+
The nomenclature uses boldfaces for vectors or matrices, capital boldface letters for
16+
vectors representing time series (and also for matrices), and hats for the predictions
17+
(and also for the observer estimations).
1718

1819
To be precise, at the ``k``th control period, the vectors that encompass the future measured
1920
disturbances ``\mathbf{d̂}``, model outputs ``\mathbf{ŷ}`` and setpoints ``\mathbf{r̂_y}``
@@ -31,7 +32,9 @@ over the prediction horizon ``H_p`` are defined as:
3132
\end{bmatrix}
3233
```
3334

34-
The vectors for the manipulated input ``\mathbf{u}`` are shifted by one time step:
35+
in which ``\mathbf{D̂}``, ``\mathbf{Ŷ}`` and ``\mathbf{R̂_y}`` are vectors of `nd*Hp`, `ny*Hp`
36+
and `ny*Hp` elements, respectively. The vectors for the manipulated input ``\mathbf{u}``
37+
are shifted by one time step:
3538

3639
```math
3740
\mathbf{U} = \begin{bmatrix}
@@ -42,10 +45,10 @@ The vectors for the manipulated input ``\mathbf{u}`` are shifted by one time ste
4245
\end{bmatrix}
4346
```
4447

45-
Defining the manipulated input increment as ``\mathbf{Δu}(k+j) =
46-
\mathbf{u}(k+j) - \mathbf{u}(k+j-1)``, the control horizon ``H_c`` enforces that
47-
``\mathbf{Δu}(k+j) = \mathbf{0}`` for ``j ≥ H_c``. For this reason, the vector that collects
48-
them is truncated up to ``k+H_c-1``:
48+
in which ``\mathbf{U}`` and ``\mathbf{R̂_u}`` are both vectors of `nu*Hp` elements. Defining
49+
the manipulated input increment as ``\mathbf{Δu}(k+j) = \mathbf{u}(k+j) - \mathbf{u}(k+j-1)``,
50+
the control horizon ``H_c`` enforces that ``\mathbf{Δu}(k+j) = \mathbf{0}`` for ``j ≥ H_c``.
51+
For this reason, the vector that collects them is truncated up to ``k+H_c-1``:
4952

5053
```math
5154
\mathbf{ΔU} =
@@ -54,6 +57,8 @@ them is truncated up to ``k+H_c-1``:
5457
\end{bmatrix}
5558
```
5659

60+
in which ``\mathbf{ΔU}`` is a vector of `nu*Hc` elements.
61+
5762
## PredictiveController
5863

5964
```@docs

docs/src/public/sim_model.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ simulators by calling [`evaloutput`](@ref) and [`updatestate!`](@ref) methods on
1111
the states ``\mathbf{x}`` are stored inside [`SimModel`](@ref) instances. Use [`setstate!`](@ref)
1212
method to manually modify them.
1313

14+
!!! info
15+
The nomenclature in this page introduces the model manipulated input ``\mathbf{u}``,
16+
measured disturbances ``\mathbf{d}``, state ``\mathbf{x}`` and output ``\mathbf{y}``,
17+
four vectors of `nu`, `nd`, `nx` and `ny` elements, respectively. The ``\mathbf{z}``
18+
vector combines the elements of ``\mathbf{u}`` and ``\mathbf{d}``.
19+
1420
## SimModel
1521

1622
```@docs

docs/src/public/state_estim.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,10 @@ solving the MPC problem with [`moveinput!`](@ref), for when the estimations are
2828
[^1]: also denoted ``\mathbf{x̂}_{k|k}`` [elsewhere](https://en.wikipedia.org/wiki/Kalman_filter).
2929

3030
!!! info
31-
All the estimators support measured ``\mathbf{y^m}`` and unmeasured ``\mathbf{y^u}``
32-
model outputs, where ``\mathbf{y}`` refers to all of them.
31+
The nomenclature in this page introduces the estimated state ``\mathbf{x̂}`` and output
32+
``\mathbf{ŷ}`` vectors of respectively `nx̂` and `ny` elements. Also, all the estimators
33+
support measured ``\mathbf{y^m}`` (`nym` elements) and unmeasured ``\mathbf{y^u}``
34+
(`nyu` elements) model output, where ``\mathbf{y}`` refers to all of them.
3335

3436
## StateEstimator
3537

0 commit comments

Comments
 (0)