Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
update integral_action docstrings (must be ndarray)
  • Loading branch information
murrayrm committed Mar 18, 2023
commit 1535738c5c649f161aa4987f8a18f765745808d8
41 changes: 20 additions & 21 deletions control/statefbk.py
Original file line number Diff line number Diff line change
Expand Up @@ -338,12 +338,13 @@ def lqr(*args, **kwargs):
N : 2D array, optional
Cross weight matrix
integral_action : ndarray, optional
If this keyword is specified, the controller includes integral action
in addition to state feedback. The value of the `integral_action``
keyword should be an ndarray that will be multiplied by the current to
generate the error for the internal integrator states of the control
law. The number of outputs that are to be integrated must match the
number of additional rows and columns in the ``Q`` matrix.
If this keyword is specified, the controller includes integral
action in addition to state feedback. The value of the
`integral_action`` keyword should be an ndarray that will be
multiplied by the current state to generate the error for the
internal integrator states of the control law. The number of
outputs that are to be integrated must match the number of
additional rows and columns in the ``Q`` matrix.
method : str, optional
Set the method used for computing the result. Current methods are
'slycot' and 'scipy'. If set to None (default), try 'slycot' first
Expand Down Expand Up @@ -487,12 +488,13 @@ def dlqr(*args, **kwargs):
N : 2D array, optional
Cross weight matrix
integral_action : ndarray, optional
If this keyword is specified, the controller includes integral action
in addition to state feedback. The value of the `integral_action``
keyword should be an ndarray that will be multiplied by the current to
generate the error for the internal integrator states of the control
law. The number of outputs that are to be integrated must match the
number of additional rows and columns in the ``Q`` matrix.
If this keyword is specified, the controller includes integral
action in addition to state feedback. The value of the
`integral_action`` keyword should be an ndarray that will be
multiplied by the current state to generate the error for the
internal integrator states of the control law. The number of
outputs that are to be integrated must match the number of
additional rows and columns in the ``Q`` matrix.
method : str, optional
Set the method used for computing the result. Current methods are
'slycot' and 'scipy'. If set to None (default), try 'slycot' first
Expand Down Expand Up @@ -520,6 +522,7 @@ def dlqr(*args, **kwargs):
--------
>>> K, S, E = dlqr(dsys, Q, R, [N])
>>> K, S, E = dlqr(A, B, Q, R, [N])

"""

#
Expand Down Expand Up @@ -654,16 +657,12 @@ def create_statefbk_iosystem(
ud_labels. These settings can also be overriden using the `inputs`
keyword.

integral_action : None, ndarray, or func, optional
integral_action : ndarray, optional
If this keyword is specified, the controller can include integral
action in addition to state feedback. If ``integral_action`` is a
matrix, it will be multiplied by the current and desired state to
generate the error for the internal integrator states of the control
law. If ``integral_action`` is a function ``h``, that function will
be called with the signature h(t, x, u, params) to obtain the
outputs that should be integrated. The number of outputs that are
to be integrated must match the number of additional columns in the
``K`` matrix.
action in addition to state feedback. The value of the
`integral_action`` keyword should be an ndarray that will be
multiplied by the current and desired state to generate the error
for the internal integrator states of the control law.

estimator : InputOutputSystem, optional
If an estimator is provided, use the states of the estimator as
Expand Down
2 changes: 1 addition & 1 deletion control/timeresp.py
Original file line number Diff line number Diff line change
Expand Up @@ -1384,7 +1384,7 @@ def step_info(sysdata, T=None, T_num=None, yfinal=None,
Parameters
----------
sysdata : StateSpace or TransferFunction or array_like
The system data. Either LTI system to similate (StateSpace,
The system data. Either LTI system to simulate (StateSpace,
TransferFunction), or a time series of step response data.
T : array_like or float, optional
Time vector, or simulation time duration if a number (time vector is
Expand Down