Skip to content

Commit 3e6347f

Browse files
committed
update lqr() return type documentation (addresses #418)
1 parent 97c4a65 commit 3e6347f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

control/statefbk.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,9 +374,9 @@ def lqr(*args, **keywords):
374374
375375
Returns
376376
-------
377-
K: 2D array
377+
K: 2D array (or matrix)
378378
State feedback gains
379-
S: 2D array
379+
S: 2D array (or matrix)
380380
Solution to Riccati equation
381381
E: 1D array
382382
Eigenvalues of the closed loop system
@@ -390,6 +390,12 @@ def lqr(*args, **keywords):
390390
--------
391391
lqe
392392
393+
Notes
394+
-----
395+
The return type for `K` and `S` depends on the default class set for
396+
state space operations. By default, this is the Numpy `matrix`
397+
class in this release, but this can be reconfigured using the
398+
:func:`~control.use_numpy_matrix` function.
393399
"""
394400

395401
# Make sure that SLICOT is installed

0 commit comments

Comments
 (0)