Skip to content

klist->gains kwarg for matlab.wrappers.rlocus #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 11, 2024
Merged

klist->gains kwarg for matlab.wrappers.rlocus #999

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5e2639
klist->gains #998
May 10, 2024
cb4244d
DOC: update keywords of matlab.wrappers.rlocus
slivingston May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions control/matlab/wrappers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,19 +197,19 @@ def _parse_freqplot_args(*args):

# TODO: rewrite to call root_locus_map, without using legacy plot keyword
def rlocus(*args, **kwargs):
"""rlocus(sys[, klist, xlim, ylim, ...])
"""rlocus(sys[, gains, xlim, ylim, ...])

Root locus diagram.

Calculate the root locus by finding the roots of 1 + k * G(s) where G
is a linear system with transfer function num(s)/den(s) and each k is
an element of kvect.
an element of gains.

Parameters
----------
sys : LTI object
Linear input/output systems (SISO only, for now).
kvect : array_like, optional
gains : array_like, optional
Gains to use in computing plot of closed-loop poles.
xlim : tuple or list, optional
Set limits of x axis, normally with tuple
Expand All @@ -224,7 +224,7 @@ def rlocus(*args, **kwargs):
Closed-loop root locations, arranged in which each row corresponds
to a gain in gains.
gains : ndarray
Gains used. Same as kvect keyword argument if provided.
Gains used. Same as gains keyword argument if provided.

Notes
-----
Expand Down