Skip to content

Commit b6341bc

Browse files
authored
Merge pull request #196 from JuliaControl/doc_correction
doc: minor corrections
2 parents 6c5f770 + 7d0f520 commit b6341bc

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

src/controller/transcription.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -952,13 +952,13 @@ linconstrainteq!(::PredictiveController, ::SimModel, ::SingleShooting) = nothing
952952
linconstrainteq!(::PredictiveController, ::SimModel, ::MultipleShooting) = nothing
953953

954954
@doc raw"""
955-
set_warmstart!(mpc::PredictiveController, transcription::SingleShooting, Z̃var) -> Z̃0
955+
set_warmstart!(mpc::PredictiveController, transcription::SingleShooting, Z̃var) -> Z̃s
956956
957957
Set and return the warm start value of `Z̃var` for [`SingleShooting`](@ref) transcription.
958958
959959
If supported by `mpc.optim`, it warm-starts the solver at:
960960
```math
961-
\mathbf{ΔŨ} =
961+
\mathbf{Z̃_s} =
962962
\begin{bmatrix}
963963
\mathbf{Δu}(k+0|k-1) \\
964964
\mathbf{Δu}(k+1|k-1) \\
@@ -983,13 +983,13 @@ function set_warmstart!(mpc::PredictiveController, transcription::SingleShooting
983983
end
984984

985985
@doc raw"""
986-
set_warmstart!(mpc::PredictiveController, transcription::MultipleShooting, Z̃var) -> Z̃0
986+
set_warmstart!(mpc::PredictiveController, transcription::MultipleShooting, Z̃var) -> Z̃s
987987
988988
Set and return the warm start value of `Z̃var` for [`MultipleShooting`](@ref) transcription.
989989
990990
It warm-starts the solver at:
991991
```math
992-
\mathbf{ΔŨ} =
992+
\mathbf{Z̃_s} =
993993
\begin{bmatrix}
994994
\mathbf{Δu}(k+0|k-1) \\
995995
\mathbf{Δu}(k+1|k-1) \\

src/model/nonlinmodel.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ form. The optional parameter `NT` explicitly set the number type of vectors (def
111111
!!! warning
112112
The two functions must be in pure Julia to use the model in [`NonLinMPC`](@ref),
113113
[`ExtendedKalmanFilter`](@ref), [`MovingHorizonEstimator`](@ref) and [`linearize`](@ref),
114-
except if a finite difference backend is used (e.g. [`AutoFiniteDiff`](@extref DifferentiationInterface List).
114+
except if a finite difference backend is used (e.g. [`AutoFiniteDiff`](@extref DifferentiationInterface List)).
115115
116116
See also [`LinModel`](@ref).
117117

0 commit comments

Comments
 (0)