From c5e2639d80e6a28ce6176c7a7d1e97039da290b4 Mon Sep 17 00:00:00 2001 From: Geordie McBain Date: Fri, 10 May 2024 14:17:42 +1000 Subject: [PATCH 1/2] klist->gains #998 --- control/matlab/wrappers.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/control/matlab/wrappers.py b/control/matlab/wrappers.py index 0384215a8..6e2bc83bc 100644 --- a/control/matlab/wrappers.py +++ b/control/matlab/wrappers.py @@ -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 From cb4244ddc9ba3767f6e6d6dfd7cbd676db319a38 Mon Sep 17 00:00:00 2001 From: "Scott C. Livingston" Date: Fri, 10 May 2024 16:30:30 -0700 Subject: [PATCH 2/2] DOC: update keywords of matlab.wrappers.rlocus --- control/matlab/wrappers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/control/matlab/wrappers.py b/control/matlab/wrappers.py index 6e2bc83bc..153342096 100644 --- a/control/matlab/wrappers.py +++ b/control/matlab/wrappers.py @@ -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 -----