Skip to content

Commit

Permalink
add docstring output to setconstraint! example
Browse files Browse the repository at this point in the history
  • Loading branch information
franckgaga committed Aug 1, 2023
1 parent 6fecbfe commit 412c16d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/predictive_control.jl
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,14 @@ julia> mpc = LinMPC(setop!(LinModel(tf(3, [30, 1]), 4), uop=[50], yop=[25]));
julia> mpc = setconstraint!(mpc, umin=[0], umax=[100], c_umin=[0.0], c_umax=[0.0]);
julia> mpc = setconstraint!(mpc, Δumin=[-10], Δumax=[+10], c_Δumin=[1.0], c_Δumax=[1.0])
LinMPC controller with a sample time Ts = 4.0 s, SteadyKalmanFilter estimator and:
10 prediction steps Hp
2 control steps Hc
1 manipulated inputs u
2 states x̂
1 measured outputs ym
0 unmeasured outputs yu
0 measured disturbances d
```
"""
function setconstraint!(
Expand Down

2 comments on commit 412c16d

@franckgaga
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/88815

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.6.2 -m "<description of version>" 412c16d8aa775c986ac6bd0ae5764f8f753b80e7
git push origin v0.6.2

Please sign in to comment.