Skip to content

Commit

Permalink
Improve documentation for step and impulse
Browse files Browse the repository at this point in the history
  • Loading branch information
KronosTheLate committed Oct 5, 2020
1 parent e4f19d4 commit 0b6ca0c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/timeresp.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
Calculate the step response of system `sys`. If the final time `Tf` or time
vector `t` is not provided, one is calculated based on the system pole
locations.
The step on the input goes from 0 to 1 and occurs at t=0.
`y` has size `(length(t), ny, nu)`, `x` has size `(length(t), nx, nu)`"""
function Base.step(sys::StateSpace, t::AbstractVector; method=:cont)
Expand Down Expand Up @@ -36,6 +37,9 @@ Base.step(sys::TransferFunction, t::AbstractVector; kwargs...) = step(ss(sys), t
Calculate the impulse response of system `sys`. If the final time `Tf` or time
vector `t` is not provided, one is calculated based on the system pole
locations.
The the impulse is such that the area under it is 1, with the shortest possible time-step.
For continuos systems this is the Dirac delta function.
For discrete systems this is the Kronecker delta function.
`y` has size `(length(t), ny, nu)`, `x` has size `(length(t), nx, nu)`"""
function impulse(sys::StateSpace, t::AbstractVector; method=:cont)
Expand Down

0 comments on commit 0b6ca0c

Please sign in to comment.