sort loci in PoleZeroData #1070
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slivingston
reviewed
Dec 2, 2024
control/pzmap.py
Outdated
| @@ -79,11 +79,13 @@ class PoleZeroData: | |||
| System name. | |||
| sys : StateSpace or TransferFunction | |||
| System corresponding to the data. | |||
| sort_loci : bool, optional) | |||
There was a problem hiding this comment.
Suggested change
| sort_loci : bool, optional) | |
| sort_loci : bool, optional |
slivingston
approved these changes
Dec 2, 2024
There was a problem hiding this comment.
There is a small misprint in the docstring. Besides that, this is ready to merge.
Not related to code: the PR description refers to Example 6.8 but links to Example 5.17. This PR is clearly relevant to Example 5.17, so I guess "Example 6.8" is a misprint or perhaps example numbers changed in the book, but I want to bring attention to it in case it indicates that more actions are necessary.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This small PR adds the option to sort loci when creating a PoleZeroData object. This is useful if you create a PoleZeroData object in some way other than calling
root_locus_map(which sorts the data ahead of time).The need for this functionality came up when working through Example 5.17 of FBS2e (bicycle eigenvalue location versus speed), as shown in the following code:
https://github.com/murrayrm/fbs2e-python/blob/main/example-5.17-bicycle_stability.py
(At some point I would like to generalized the root locus capability to allow plotting an eigenvalue locus diagram against any free parameter in a nonlinear system, but that will take more time and effort.)