Skip to content

process legacy rlocus keyword k->gains #1003

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 3 commits into from
May 22, 2024
Merged

process legacy rlocus keyword k->gains #1003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
206ca85
process legacy keyword k->gains #999
gdmcbain May 13, 2024
b58f435
test deprecated 'k' keyword for rlocus
gdmcbain May 22, 2024
12865cf
Merge branch 'main' into rlocus-k
gdmcbain May 22, 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
3 changes: 2 additions & 1 deletion control/rlocus.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,8 @@ def root_locus_plot(
from .pzmap import pole_zero_plot

# Legacy parameters
gains = config._process_legacy_keyword(kwargs, 'kvect', 'gains', gains)
for oldkey in ['kvect', 'k']:
gains = config._process_legacy_keyword(kwargs, oldkey, 'gains', gains)

# Set default parameters
grid = config._get_param('rlocus', 'grid', grid, _rlocus_defaults)
Expand Down
7 changes: 4 additions & 3 deletions control/tests/rlocus_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,11 @@ def test_root_locus_plots(sys, grid, xlim, ylim, interactive):


# Test deprecated keywords
def test_root_locus_legacy():
@pytest.mark.parametrize("keyword", ["kvect", "k"])
def test_root_locus_legacy(keyword):
sys = ct.rss(2, 1, 1)
with pytest.warns(DeprecationWarning, match="'kvect' is deprecated"):
ct.root_locus_plot(sys, kvect=[0, 1, 2])
with pytest.warns(DeprecationWarning, match=f"'{keyword}' is deprecated"):
ct.root_locus_plot(sys, **{keyword: [0, 1, 2]})


# Generate plots used in documentation
Expand Down