Skip to content

Commit c888ccc

Browse files
murrayrmmurrayrm
committed
initial set of developer notes
1 parent a8d5ff9 commit c888ccc

7 files changed

Lines changed: 644 additions & 19 deletions

File tree

‎control/config.py‎

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -376,15 +376,37 @@ def use_legacy_defaults(version):
376376
return (major, minor, patch)
377377

378378

379-
#
380-
# Utility function for processing legacy keywords
381-
#
382-
# Use this function to handle a legacy keyword that has been renamed. This
383-
# function pops the old keyword off of the kwargs dictionary and issues a
384-
# warning. If both the old and new keyword are present, a ControlArgument
385-
# exception is raised.
386-
#
387379
def _process_legacy_keyword(kwargs, oldkey, newkey, newval, warn_oldkey=True):
380+
"""Utility function for processing legacy keywords.
381+
382+
Use this function to handle a legacy keyword that has been renamed.
383+
This function pops the old keyword off of the kwargs dictionary and
384+
issues a warning. If both the old and new keyword are present, a
385+
ControlArgument exception is raised.
386+
387+
Parameters
388+
----------
389+
kwargs : dict
390+
Dictionary of keword arguments (from function call).
391+
oldkey : str
392+
Old (legacy) parameter name.
393+
newkey : str
394+
Current name of the parameter.
395+
newval : object
396+
Value of the current parameter (from the function signature).
397+
warn_oldkey : bool
398+
If set to `False`, suppress generation of a warning about using a
399+
legacy keyword. This is useful if you have two versions of a
400+
keyword and you want to allow either to be used (see the `cost` and
401+
`trajectory_cost` keywords in `flatsys.point_to_point` for an
402+
example of this).
403+
404+
Returns
405+
-------
406+
val : object
407+
Value of the (new) keyword.
408+
409+
"""
388410
if oldkey in kwargs:
389411
if warn_oldkey:
390412
warnings.warn(

‎control/xferfcn.py‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1480,29 +1480,32 @@ def _convert_to_transfer_function(
14801480
sys, inputs=1, outputs=1, use_prefix_suffix=False):
14811481
"""Convert a system to transfer function form (if needed).
14821482
1483-
If sys is already a transfer function, then it is returned. If sys is a
1484-
state space object, then it is converted to a transfer function and
1485-
returned. If sys is a scalar, then the number of inputs and outputs can be
1486-
specified manually, as in:
1483+
If `sys` is already a transfer function, then it is returned. If `sys`
1484+
is a state space object, then it is converted to a transfer function
1485+
and returned. If `sys` is a scalar, then the number of inputs and
1486+
outputs can be specified manually, as in::
14871487
14881488
>>> from control.xferfcn import _convert_to_transfer_function
14891489
>>> sys = _convert_to_transfer_function(3.) # Assumes inputs = outputs = 1
14901490
>>> sys = _convert_to_transfer_function(1., inputs=3, outputs=2)
14911491
1492-
In the latter example, sys's matrix transfer function is [[1., 1., 1.]
1493-
[1., 1., 1.]].
1492+
In the latter example, the matrix transfer function for `sys` is::
14941493
1495-
If sys is an array-like type, then it is converted to a constant-gain
1494+
[[1., 1., 1.]
1495+
[1., 1., 1.]].
1496+
1497+
If `sys` is an array-like type, then it is converted to a constant-gain
14961498
transfer function.
14971499
14981500
Note: no renaming of inputs and outputs is performed; this should be done
14991501
by the calling function.
15001502
1501-
>>> sys = _convert_to_transfer_function([[1., 0.], [2., 3.]])
1503+
Arrays can also be passed as an argument. For example::
1504+
1505+
sys = _convert_to_transfer_function([[1., 0.], [2., 3.]])
15021506
1503-
In this example, the numerator matrix will be
1504-
[[[1.0], [0.0]], [[2.0], [3.0]]]
1505-
and the denominator matrix [[[1.0], [1.0]], [[1.0], [1.0]]]
1507+
will give a system with numerator matrix `[[[1.0], [0.0]], [[2.0],
1508+
[3.0]]]` and denominator matrix `[[[1.0], [1.0]], [[1.0], [1.0]]]`.
15061509
15071510
"""
15081511
from .statesp import StateSpace

‎doc/config.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,15 @@ System display parameters
151151
* 'eval' : system specific, loadable representation
152152
* 'latex' : latex representation of the object
153153

154+
.. py:data:: iosys.repr_show_count
155+
:type: bool
156+
:value: True
157+
158+
If `True`, show the input, output, and state count when using
159+
`iosys_repr()` and the 'eval' format. Otherwise, the input,
160+
output, and state values are repressed from the output unless
161+
non-generic signal names are present.
162+
154163
.. py:data:: xferfcn.display_format
155164
:type: str
156165
:value: 'poly'

0 commit comments

Comments
 (0)