Skip to content

Commit 1535738

Browse files
committed
update integral_action docstrings (must be ndarray)
1 parent dd1e2d3 commit 1535738

2 files changed

Lines changed: 21 additions & 22 deletions

File tree

control/statefbk.py

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -338,12 +338,13 @@ def lqr(*args, **kwargs):
338338
N : 2D array, optional
339339
Cross weight matrix
340340
integral_action : ndarray, optional
341-
If this keyword is specified, the controller includes integral action
342-
in addition to state feedback. The value of the `integral_action``
343-
keyword should be an ndarray that will be multiplied by the current to
344-
generate the error for the internal integrator states of the control
345-
law. The number of outputs that are to be integrated must match the
346-
number of additional rows and columns in the ``Q`` matrix.
341+
If this keyword is specified, the controller includes integral
342+
action in addition to state feedback. The value of the
343+
`integral_action`` keyword should be an ndarray that will be
344+
multiplied by the current state to generate the error for the
345+
internal integrator states of the control law. The number of
346+
outputs that are to be integrated must match the number of
347+
additional rows and columns in the ``Q`` matrix.
347348
method : str, optional
348349
Set the method used for computing the result. Current methods are
349350
'slycot' and 'scipy'. If set to None (default), try 'slycot' first
@@ -487,12 +488,13 @@ def dlqr(*args, **kwargs):
487488
N : 2D array, optional
488489
Cross weight matrix
489490
integral_action : ndarray, optional
490-
If this keyword is specified, the controller includes integral action
491-
in addition to state feedback. The value of the `integral_action``
492-
keyword should be an ndarray that will be multiplied by the current to
493-
generate the error for the internal integrator states of the control
494-
law. The number of outputs that are to be integrated must match the
495-
number of additional rows and columns in the ``Q`` matrix.
491+
If this keyword is specified, the controller includes integral
492+
action in addition to state feedback. The value of the
493+
`integral_action`` keyword should be an ndarray that will be
494+
multiplied by the current state to generate the error for the
495+
internal integrator states of the control law. The number of
496+
outputs that are to be integrated must match the number of
497+
additional rows and columns in the ``Q`` matrix.
496498
method : str, optional
497499
Set the method used for computing the result. Current methods are
498500
'slycot' and 'scipy'. If set to None (default), try 'slycot' first
@@ -520,6 +522,7 @@ def dlqr(*args, **kwargs):
520522
--------
521523
>>> K, S, E = dlqr(dsys, Q, R, [N])
522524
>>> K, S, E = dlqr(A, B, Q, R, [N])
525+
523526
"""
524527

525528
#
@@ -654,16 +657,12 @@ def create_statefbk_iosystem(
654657
ud_labels. These settings can also be overriden using the `inputs`
655658
keyword.
656659
657-
integral_action : None, ndarray, or func, optional
660+
integral_action : ndarray, optional
658661
If this keyword is specified, the controller can include integral
659-
action in addition to state feedback. If ``integral_action`` is a
660-
matrix, it will be multiplied by the current and desired state to
661-
generate the error for the internal integrator states of the control
662-
law. If ``integral_action`` is a function ``h``, that function will
663-
be called with the signature h(t, x, u, params) to obtain the
664-
outputs that should be integrated. The number of outputs that are
665-
to be integrated must match the number of additional columns in the
666-
``K`` matrix.
662+
action in addition to state feedback. The value of the
663+
`integral_action`` keyword should be an ndarray that will be
664+
multiplied by the current and desired state to generate the error
665+
for the internal integrator states of the control law.
667666
668667
estimator : InputOutputSystem, optional
669668
If an estimator is provided, use the states of the estimator as

control/timeresp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1384,7 +1384,7 @@ def step_info(sysdata, T=None, T_num=None, yfinal=None,
13841384
Parameters
13851385
----------
13861386
sysdata : StateSpace or TransferFunction or array_like
1387-
The system data. Either LTI system to similate (StateSpace,
1387+
The system data. Either LTI system to simulate (StateSpace,
13881388
TransferFunction), or a time series of step response data.
13891389
T : array_like or float, optional
13901390
Time vector, or simulation time duration if a number (time vector is

0 commit comments

Comments
 (0)