@@ -134,16 +134,17 @@ def place_varga(A, B, p, dtime=False, alpha=None):
134134
135135 Optional Parameters
136136 ---------------
137- dtime: False for continuous time pole placement or True for discrete time.
138- The default is dtime=False.
139- alpha: double scalar
140- If DICO='C', then place_varga will leave the eigenvalues with real
141- real part less than alpha untouched.
142- If DICO='D', the place_varga will leave eigenvalues with modulus
143- less than alpha untouched.
137+ dtime : bool
138+ False for continuous time pole placement or True for discrete time.
139+ The default is dtime=False.
144140
145- By default (alpha=None), place_varga computes alpha such that all
146- poles will be placed.
141+ alpha : double scalar
142+ If DICO='C', then place_varga will leave the eigenvalues with real real
143+ part less than alpha untouched. If DICO='D', the place_varga will
144+ leave eigenvalues with modulus less than alpha untouched.
145+
146+ By default (alpha=None), place_varga computes alpha such that all poles
147+ will be placed.
147148
148149 Returns
149150 -------
@@ -153,14 +154,13 @@ def place_varga(A, B, p, dtime=False, alpha=None):
153154
154155 Algorithm
155156 ---------
156- This function is a wrapper for the slycot function sb01bd, which
157- implements the pole placement algorithm of Varga [1]. In contrast to
158- the algorithm used by place(), the Varga algorithm can place
159- multiple poles at the same location. The placement, however, may not
160- be as robust.
157+ This function is a wrapper for the slycot function sb01bd, which
158+ implements the pole placement algorithm of Varga [1]. In contrast to the
159+ algorithm used by place(), the Varga algorithm can place multiple poles at
160+ the same location. The placement, however, may not be as robust.
161161
162- [1] Varga A. "A Schur method for pole assignment."
163- IEEE Trans. Automatic Control, Vol. AC-26, pp. 517-519, 1981.
162+ [1] Varga A. "A Schur method for pole assignment." IEEE Trans. Automatic
163+ Control, Vol. AC-26, pp. 517-519, 1981.
164164
165165 Examples
166166 --------
@@ -171,6 +171,7 @@ def place_varga(A, B, p, dtime=False, alpha=None):
171171 See Also:
172172 --------
173173 place, acker
174+
174175 """
175176
176177 # Make sure that SLICOT is installed
@@ -213,7 +214,7 @@ def place_varga(A, B, p, dtime=False, alpha=None):
213214 # but does the trick
214215 alpha = - 2 * abs (min (system_eigs .real ))
215216 elif dtime and alpha < 0.0 :
216- raise ValueError ("Need alpha > 0 when DICO='D' " )
217+ raise ValueError ("Discrete time systems require alpha > 0" )
217218
218219
219220 # Call SLICOT routine to place the eigenvalues
0 commit comments