Skip to content

Commit

Permalink
add cross-references to c2d from lqr docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
baggepinnen committed Jul 13, 2023
1 parent c019862 commit e6a7844
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lib/ControlSystemsBase/src/synthesis.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ The `args...; kwargs...` are sent to the Riccati solver, allowing specification
To obtain also the solution to the Riccati equation and the eigenvalues of the closed-loop system as well, call `ControlSystemsBase.MatrixEquations.arec / ared` instead (note the different order of the arguments to these functions).
To obtain a discrete-time approximation to a continuous-time LQR problem, the function [`c2d`](@ref) can be used to obtain corresponding discrete-time cost matrices.
# Examples
Continuous time
```julia
Expand Down Expand Up @@ -80,6 +82,8 @@ Calculate the optimal Kalman gain.
If `direct = true`, the observer gain is computed for the pair `(A, CA)` instead of `(A,C)`. This option is intended to be used together with the option `direct = true` to [`observer_controller`](@ref). Ref: "Computer-Controlled Systems" pp 140.
To obtain a discrete-time approximation to a continuous-time LQG problem, the function [`c2d`](@ref) can be used to obtain corresponding discrete-time covariance matrices.
The `args...; kwargs...` are sent to the Riccati solver, allowing specification of cross-covariance etc. See `?MatrixEquations.arec/ared` for more help.
"""
function kalman(te, A, C, R1,R2, args...; direct = false, kwargs...)
Expand Down

0 comments on commit e6a7844

Please sign in to comment.