Skip to content

Commit 1a9b3ed

Browse files
committed
modify augment_model docstring
1 parent 0eafd3d commit 1a9b3ed

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/state_estim.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ function init_estimstoch(i_ym, nint_ym)
128128
end
129129

130130
@doc raw"""
131-
augment_model(model::LinModel, As, Cs) -> Â, B̂u, Ĉ, B̂d, D̂d
131+
augment_model(model::LinModel, As, Cs; verify_obsv=true) -> Â, B̂u, Ĉ, B̂d, D̂d
132132
133133
Augment [`LinModel`](@ref) state-space matrices with the stochastic ones `As` and `Cs`.
134134
@@ -142,6 +142,7 @@ returns the augmented matrices `Â`, `B̂u`, `Ĉ`, `B̂d` and `D̂d`:
142142
\mathbf{ŷ}(k) &= \mathbf{Ĉ x̂}(k) + \mathbf{D̂_d d}(k)
143143
\end{aligned}
144144
```
145+
An error is thrown if the augmented model is not observable and `verify_obsv == true`.
145146
"""
146147
function augment_model(model::LinModel, As, Cs; verify_obsv=true)
147148
nu, nx, nd = model.nu, model.nx, model.nd

0 commit comments

Comments
 (0)