Skip to content

Documentation update #476

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
murrayrm merged 7 commits into from
Dec 24, 2020
Merged

Documentation update #476

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
802b47b
DOC: fix typos, equation numbering in doc/flatsys.rst
murrayrm Jan 5, 2020
7b9d1a9
small updates to statefbk.py docstrings
murrayrm Jan 18, 2020
4f49094
update setup.py contract info
murrayrm Jan 20, 2020
17c1840
small fixes to iosys docstrings (from samlaf)
murrayrm May 17, 2020
97c4a65
TRV: fix indentation in docstring
murrayrm Dec 22, 2020
3e6347f
update lqr() return type documentation (addresses #418)
murrayrm Dec 22, 2020
6ff59f0
Added 2D array/matrix note to all functions using _ssmatrix + numpydo…
murrayrm Dec 24, 2020
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
small updates to statefbk.py docstrings
  • Loading branch information
@murrayrm
murrayrm committed Dec 22, 2020
commit 7b9d1a9d080559abdcca90977fec8d1e753ad5a5
35 changes: 18 additions & 17 deletions control/statefbk.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,16 +134,17 @@ def place_varga(A, B, p, dtime=False, alpha=None):

Optional Parameters
---------------
dtime: False for continuous time pole placement or True for discrete time.
The default is dtime=False.
alpha: double scalar
If DICO='C', then place_varga will leave the eigenvalues with real
real part less than alpha untouched.
If DICO='D', the place_varga will leave eigenvalues with modulus
less than alpha untouched.
dtime : bool
False for continuous time pole placement or True for discrete time.
The default is dtime=False.

By default (alpha=None), place_varga computes alpha such that all
poles will be placed.
alpha : double scalar
If DICO='C', then place_varga will leave the eigenvalues with real real
part less than alpha untouched. If DICO='D', the place_varga will
leave eigenvalues with modulus less than alpha untouched.

By default (alpha=None), place_varga computes alpha such that all poles
will be placed.

Returns
-------
Expand All @@ -153,14 +154,13 @@ def place_varga(A, B, p, dtime=False, alpha=None):

Algorithm
---------
This function is a wrapper for the slycot function sb01bd, which
implements the pole placement algorithm of Varga [1]. In contrast to
the algorithm used by place(), the Varga algorithm can place
multiple poles at the same location. The placement, however, may not
be as robust.
This function is a wrapper for the slycot function sb01bd, which
implements the pole placement algorithm of Varga [1]. In contrast to the
algorithm used by place(), the Varga algorithm can place multiple poles at
the same location. The placement, however, may not be as robust.

[1] Varga A. "A Schur method for pole assignment."
IEEE Trans. Automatic Control, Vol. AC-26, pp. 517-519, 1981.
[1] Varga A. "A Schur method for pole assignment." IEEE Trans. Automatic
Control, Vol. AC-26, pp. 517-519, 1981.

Examples
--------
Expand All @@ -171,6 +171,7 @@ def place_varga(A, B, p, dtime=False, alpha=None):
See Also:
--------
place, acker

"""

# Make sure that SLICOT is installed
Expand Down Expand Up @@ -213,7 +214,7 @@ def place_varga(A, B, p, dtime=False, alpha=None):
# but does the trick
alpha = -2*abs(min(system_eigs.real))
elif dtime and alpha < 0.0:
raise ValueError("Need alpha > 0 when DICO='D'")
raise ValueError("Discrete time systems require alpha > 0")


# Call SLICOT routine to place the eigenvalues
Expand Down