- Notifications
You must be signed in to change notification settings - Fork446
Uniform processing of time response and optimization parameters#1125
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
coveralls commentedFeb 9, 2025
slivingston left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good work! There are still several places where_process_legacy_keyword() is called (statefbk.py, pzmap.py, ...), but we can change those later.
I marked several small items to correct.
doc/develop.rst Outdated
| ----------------- | ||
| As described above, parameter names are generally longer strings that | ||
| describe the purpose fo the paramater. Similar to `matplotlib` (e.g., |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| describe the purposefo theparamater. Similar to `matplotlib` (e.g., | |
| describe the purposefor theparameter. Similar to `matplotlib` (e.g., |
doc/develop.rst Outdated
| var = _process_kwargs('param', param, kwargs, aliases) | ||
| where 'param` is the named parameter used in the function signature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| where'param` is the named parameter used in the function signature | |
| where`param` is the named parameter used in the function signature |
control/config.py Outdated
| param = _process_param('param', defval, kwargs, function_aliases) | ||
| If `param` is a variable keyword argument (in `kwargs`), `defval` can | ||
| be pssed as either None or the default value to use if `param` is not |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| bepssedaseitherNoneorthedefaultvaluetouseif`param`isnot | |
| bepassedaseitherNoneorthedefaultvaluetouseif`param`isnot |
control/config.py Outdated
| defval : object or dict | ||
| Default value for the parameter. | ||
| kwargs : dict | ||
| Dictionary of varaible keyword arguments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Dictionaryofvaraiblekeywordarguments. | |
| Dictionaryofvariablekeywordarguments. |
| Raises | ||
| ------ | ||
| TypeError | ||
| If multiple keyword aliased are used for the same parameter. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| Ifmultiplekeywordaliasedareusedforthesameparameter. | |
| Ifmultiplekeywordaliasesareusedforthesameparameter. |
control/optimal.py Outdated
| self.states=response.states | ||
| # Parameter and keyword aliases |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This dictionary is better placed near the top of the file, next to other module-level variables like_optimal_defaults. The motivation for this practice is clarity: the variable has module-level scope, so it is in-scope for functions defined before it, too. In my experience, it is easier to have all of these variables in the same part of file, just after imports.
control/timeresp.py Outdated
| returnControlPlot(lines,cplt.axes,cplt.figure) | ||
| # Dictionary of aliases for time response commands | ||
| _timeresp_aliases= { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Same comment here as for_optimal_aliases: I recommend to move the definition of_timeresp_aliases to the top of the file, just after__all__.
| # Aliases | ||
| resp_short=ct.input_output_response(sys,timepts,1,X0=[1,1]) | ||
| np.testing.assert_allclose(resp_long.states,resp_posn.states) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| np.testing.assert_allclose(resp_long.states,resp_posn.states) | |
| np.testing.assert_allclose(resp_short.states,resp_posn.states) |
| elifnot (match:=re.search( | ||
| "\n"+r"((\w+|\.{3}), )*"+argname+r"(, (\w+|\.{3}))* :", | ||
| "\n"+r"((\w+|\.{3}), )*"+argname_+r"(, (\w+|\.{3}))* :", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
There is a search for duplicates below on line 658. Shouldargname there also be changed toargname_ ?
| # Legacy | ||
| withpytest.warns(PendingDeprecationWarning,match="legacy"): | ||
| resp_legacy=ct.input_output_response(sys,timepts,1,x0=[1,1]) | ||
| np.testing.assert_allclose(resp_long.states,resp_posn.states) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| np.testing.assert_allclose(resp_long.states,resp_posn.states) | |
| np.testing.assert_allclose(resp_legacy.states,resp_posn.states) |
a042895 intopython-control:mainUh oh!
There was an error while loading.Please reload this page.
This PR regularizes the use of various keywords for time responses and optimization routines, while maintaining backward compatibility with existing code. The motivation for the PR is that over time we have introduced different terms to refer to parameters that have the same purpose. This can be confusing for people trying to use the package.
For example:
x0andX0are used in different places for the initial state in simulation and optimization functions.return_xis used when a function should return the state as part of a tuple, though sometimereturn_statesis used instead.statesproperty (notx) and setting the the state names is done viastates.u0,U,inputs) and outputs (y0,outputs).timeptsbut other times asT.cost,trajectory_costorintegral cost, depending on the function, and constraints are referred to astrajectory_constraintsin some places asconstraintsin others.t_eval,yfinal, etc.To address these issues, this PR introduces a common set of terms across various time response and optimal control functions, with the following more consistent usage patterns and functionality:
inputs,outputs, andstatesconsistently throughout the functions.initial_state,final_output,input_indicesetc.U,Y,X0. Short form aliases are documented in docstrings by listing the parameter aslong_form (or sf) : type.PendingDeprecationWarning.TypeError.The implementation is done in a manner that can later be utilized for other functions where we want to have aliases and legacy keys, as documented in the Developer Notes section of the Reference Manual:
Two primary tables have been created in this PR. The first is a
dictionary of aliases and legacy names for time response commands (from
timeresp.py):The second is a dictionary of aliases for optimal control functions (from
optimal.py):