Skip to content

Commit d160a79

Browse files
committed
Improve docstring to meet numpydoc style
1 parent 6aa5f78 commit d160a79

File tree

1 file changed

+55
-55
lines changed

1 file changed

+55
-55
lines changed

slycot/analysis.py

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ def ab01nd(n, m, A, B, jobz='N', tol=0, ldwork=None):
6767
the order of the matrix A. ``n > 0``.
6868
m : int
6969
The number of system inputs, or of columns of B. ``m > 0``.
70-
A : (n,n) array_like
70+
A : (n, n) array_like
7171
The original state dynamics matrix A.
72-
B : (n,m) array_like
72+
B : (n, m) array_like
7373
The input matrix B.
7474
jobz : {'N', 'F', 'I'}, optional
7575
Indicates whether the user wishes to accumulate in a matrix Z
@@ -92,12 +92,12 @@ def ab01nd(n, m, A, B, jobz='N', tol=0, ldwork=None):
9292
9393
Returns
9494
-------
95-
Ac : (n,n) ndarray
95+
Ac : (n, n) ndarray
9696
The leading ncont-by-ncont part contains the upper block
9797
Hessenberg state dynamics matrix Acont in Ac, given by Z'*A*Z,
9898
of a controllable realization for the original system. The
9999
elements below the first block-subdiagonal are set to zero.
100-
Bc : (n,m) ndarray
100+
Bc : (n, m) ndarray
101101
The leading ncont-by-m part of this array contains the transformed
102102
input matrix Bcont in Bc, given by ``Z'*B``, with all elements but the
103103
first block set to zero.
@@ -164,16 +164,16 @@ def ab04md(type_t, n, m, p, A, B, C, D, alpha=1.0, beta=1.0, ldwork=None):
164164
p : int
165165
The number of rows of matrix C. It represents the dimension of
166166
the output vector. p > 0.
167-
A : (n,n) array_like
167+
A : (n, n) array_like
168168
The leading n-by-n part of this array must contain the system state
169169
matrix A.
170-
B : (n,m) array_like
170+
B : (n, m) array_like
171171
The leading n-by-m part of this array must contain the system input
172172
matrix B.
173-
C : (p,n) array_like
173+
C : (p, n) array_like
174174
The leading p-by-n part of this array must contain the system output
175175
matrix C.
176-
D : (p,m) array_like
176+
D : (p, m) array_like
177177
The leading p-by-m part of this array must contain the system direct
178178
transmission matrix D.
179179
alpha : double, optional
@@ -189,13 +189,13 @@ def ab04md(type_t, n, m, p, A, B, C, D, alpha=1.0, beta=1.0, ldwork=None):
189189
ldwork >= max(1, n), default is max(1, n)
190190
Returns
191191
-------
192-
At : (n,n) ndarray
192+
At : (n, n) ndarray
193193
The state matrix At of the transformed system.
194-
Bt : (n,m) ndarray
194+
Bt : (n, m) ndarray
195195
The input matrix Bt of the transformed system.
196-
Ct : (p,n) ndarray
196+
Ct : (p, n) ndarray
197197
The output matrix Ct of the transformed system.
198-
Dt : (p,m) ndarray
198+
Dt : (p, m) ndarray
199199
The transmission matrix Dt of the transformed system.
200200
Raises
201201
------
@@ -241,28 +241,28 @@ def ab05md(n1,m1,p1,n2,p2,A1,B1,C1,D1,A2,B2,C2,D2,uplo='U'):
241241
of the matrix A2. n2 > 0.
242242
p2 : int
243243
The number of output variables from the second system. p2 > 0.
244-
A1 : (n1,n1) array_like
244+
A1 : (n1, n1) array_like
245245
The leading n1-by-n1 part of this array must contain the state
246246
transition matrix A1 for the first system.
247-
B1 : (n1,m1) array_like
247+
B1 : (n1, m1) array_like
248248
The leading n1-by-m1 part of this array must contain the input/state
249249
matrix B1 for the first system.
250-
C1 : (p1,n1) array_like
250+
C1 : (p1, n1) array_like
251251
The leading p1-by-n1 part of this array must contain the state/output
252252
matrix C1 for the first system.
253-
D1 : (p1,m1) array_like
253+
D1 : (p1, m1) array_like
254254
The leading p1-by-m1 part of this array must contain the input/output
255255
matrix D1 for the first system.
256-
A2 : (n2,n2) array_like
256+
A2 : (n2, n2) array_like
257257
The leading n2-by-n2 part of this array must contain the state
258258
transition matrix A2 for the second system.
259-
B2 : (n2,p1) array_like
259+
B2 : (n2, p1) array_like
260260
The leading n2-by-p1 part of this array must contain the input/state
261261
matrix B2 for the second system.
262-
C2 : (p2,n2) array_like
262+
C2 : (p2, n2) array_like
263263
The leading p2-by-n2 part of this array must contain the state/output
264264
matrix C2 for the second system.
265-
D2 : (p2,p1) array_like
265+
D2 : (p2, p1) array_like
266266
The leading p2-by-p1 part of this array must contain the input/output
267267
matrix D2 for the second system.
268268
uplo : {'U', 'L'}, optional
@@ -278,16 +278,16 @@ def ab05md(n1,m1,p1,n2,p2,A1,B1,C1,D1,A2,B2,C2,D2,uplo='U'):
278278
The number of state variables (n1 + n2) in the resulting system,
279279
i.e. the order of the matrix A, the number of rows of B and
280280
the number of columns of C.
281-
A : (n1+n2,n1+n2) ndarray
281+
A : (n1+n2, n1+n2) ndarray
282282
The leading N-by-N part of this array contains the state transition
283283
matrix A for the cascaded system.
284-
B : (n1+n2,m1) ndarray
284+
B : (n1+n2, m1) ndarray
285285
The leading n-by-m1 part of this array contains the input/state
286286
matrix B for the cascaded system.
287-
C : (p2,n1+n2) ndarray
287+
C : (p2, n1+n2) ndarray
288288
The leading p2-by-n part of this array contains the state/output
289289
matrix C for the cascaded system.
290-
D : (p2,m1) ndarray
290+
D : (p2, m1) ndarray
291291
The leading p2-by-m1 part of this array contains the input/output
292292
matrix D for the cascaded system.
293293
@@ -333,28 +333,28 @@ def ab05nd(n1,m1,p1,n2,A1,B1,C1,D1,A2,B2,C2,D2,alpha=1.0,ldwork=None):
333333
n2 : int
334334
The number of state variables in the second system, i.e. the order
335335
of the matrix A2. n2 > 0.
336-
A1 : (n1,n1) array_like
336+
A1 : (n1, n1) array_like
337337
The leading n1-by-n1 part of this array must contain the state
338338
transition matrix A1 for the first system.
339-
B1 : (n1,m1) array_like
339+
B1 : (n1, m1) array_like
340340
The leading n1-by-m1 part of this array must contain the input/state
341341
matrix B1 for the first system.
342-
C1 : (p1,n1) array_like
342+
C1 : (p1, n1) array_like
343343
The leading p1-by-n1 part of this array must contain the state/output
344344
matrix C1 for the first system.
345-
D1 : (p1,m1) array_like
345+
D1 : (p1, m1) array_like
346346
The leading p1-by-m1 part of this array must contain the input/output
347347
matrix D1 for the first system.
348-
A2 : (n2,n2) array_like
348+
A2 : (n2, n2) array_like
349349
The leading n2-by-n2 part of this array must contain the state
350350
transition matrix A2 for the second system.
351-
B2 : (n2,p1) array_like
351+
B2 : (n2, p1) array_like
352352
The leading n2-by-p1 part of this array must contain the input/state
353353
matrix B2 for the second system.
354-
C2 : (m1,n2) array_like
354+
C2 : (m1, n2) array_like
355355
The leading m1-by-n2 part of this array must contain the state/output
356356
matrix C2 for the second system.
357-
D2 : (m1,p1) array_like
357+
D2 : (m1, p1) array_like
358358
The leading m1-by-p1 part of this array must contain the input/output
359359
matrix D2 for the second system.
360360
alpha : float, optional
@@ -373,16 +373,16 @@ def ab05nd(n1,m1,p1,n2,A1,B1,C1,D1,A2,B2,C2,D2,alpha=1.0,ldwork=None):
373373
The number of state variables (n1 + n2) in the connected system, i.e.
374374
the order of the matrix A, the number of rows of B and the number of
375375
columns of C.
376-
A : (n1+n2,n1+n2) ndarray
376+
A : (n1+n2, n1+n2) ndarray
377377
The leading n-by-n part of this array contains the state transition
378378
matrix A for the connected system.
379-
B : (n1+n2,m1) ndarray
379+
B : (n1+n2, m1) ndarray
380380
The leading n-by-m1 part of this array contains the input/state
381381
matrix B for the connected system.
382-
C : (p1,n1,n2) ndarray
382+
C : (p1, n1, n2) ndarray
383383
The leading p1-by-n part of this array contains the state/output
384384
matrix C for the connected system.
385-
D : (p1,m1) ndarray
385+
D : (p1, m1) ndarray
386386
The leading p1-by-m1 part of this array contains the input/output
387387
matrix D for the connected system.
388388
@@ -419,19 +419,19 @@ def ab07nd(n,m,A,B,C,D,ldwork=None):
419419
Parameters
420420
----------
421421
n : int
422-
The order of the state matrix A. n >= 0.
422+
The order of the state matrix A. n >= 0.
423423
m : int
424-
The number of system inputs and outputs. m >= 0.
425-
A : (n,n) array_like
424+
The number of system inputs and outputs. m >= 0.
425+
A : (n, n) array_like
426426
The leading n-by-n part of this array must contain the state matrix
427427
A of the original system.
428-
B : (n,m) array_like
428+
B : (n, m) array_like
429429
The leading n-by-m part of this array must contain the input matrix
430430
B of the original system.
431-
C : (m,n) array_like
431+
C : (m, n) array_like
432432
The leading m-by-n part of this array must contain the output matrix
433433
C of the original system.
434-
D : (m,m) array_like
434+
D : (m, m) array_like
435435
The leading m-by-m part of this array must contain the feedthrough
436436
matrix D of the original system.
437437
ldwork : int, optional
@@ -440,16 +440,16 @@ def ab07nd(n,m,A,B,C,D,ldwork=None):
440440
441441
Returns
442442
-------
443-
Ai : (n,n) ndarray
443+
Ai : (n, n) ndarray
444444
The leading n-by-n part of this array contains the state matrix Ai
445445
of the inverse system.
446-
Bi : (n,m) ndarray
446+
Bi : (n, m) ndarray
447447
The leading n-by-m part of this array contains the input matrix Bi
448448
of the inverse system.
449-
Ci : (m,n) ndarray
449+
Ci : (m, n) ndarray
450450
The leading m-by-n part of this array contains the output matrix Ci
451451
of the inverse system.
452-
Di : (m,m) ndarray
452+
Di : (m, m) ndarray
453453
The leading m-by-m part of this array contains the feedthrough
454454
matrix Di of the inverse system.
455455
rcond : float
@@ -707,11 +707,11 @@ def ab09ad(dico,job,equil,n,m,p,A,B,C,nr=None,tol=0,ldwork=None):
707707
Balance `B` or not `N`
708708
equil : {'S', 'N'}
709709
Scale `S` or not `N`
710-
n : input int
710+
n : int
711711
The number of state variables. n >= 0.
712-
m : input int
712+
m : int
713713
The number of system inputs. m >= 0.
714-
p : input int
714+
p : int
715715
The number of system outputs. p >= 0.
716716
A : (n, n) array_like
717717
The leading n-by-n part of this array must contain the state
@@ -994,7 +994,7 @@ def ab09bd(dico,job,equil,n,m,p,A,B,C,D,nr=None,tol1=0,tol2=0,ldwork=None):
994994
nr is the desired order of
995995
the resulting reduced order system. 0 <= nr <= n.
996996
Default is None.
997-
tol1 : double precision, optional
997+
tol1 : float, optional
998998
If ordsel = 'A', tol1 contains the tolerance for
999999
determining the order of reduced system.
10001000
For model reduction, the recommended value is
@@ -1007,7 +1007,7 @@ def ab09bd(dico,job,equil,n,m,p,A,B,C,D,nr=None,tol1=0,tol2=0,ldwork=None):
10071007
This value is used by default if tol1 <= 0 on entry.
10081008
If ordsel = 'F', the value of tol1 is ignored.
10091009
Default is `0.0`.
1010-
tol2 : double precision, optional
1010+
tol2 : float, optional
10111011
The tolerance for determining the order of a minimal
10121012
realization of the given system. The recommended value is
10131013
tol2 = n*eps*hnorm(A,B,C). This value is used by default
@@ -1148,7 +1148,7 @@ def ab09md(dico,job,equil,n,m,p,A,B,C,alpha=None,nr=None,tol=0,ldwork=None):
11481148
On entry with ordsel = 'F', nr is the desired order of the
11491149
resulting reduced order system. 0 <= nr <= n.
11501150
Default is None.
1151-
tol : double precision, optional
1151+
tol : float, optional
11521152
If ordsel = 'A', tol contains the tolerance for
11531153
determining the order of reduced system.
11541154
For model reduction, the recommended value is
@@ -1322,7 +1322,7 @@ def ab09nd(dico,job,equil,n,m,p,A,B,C,D,alpha=None,nr=None,tol1=0,tol2=0,ldwork=
13221322
nr is the desired order of
13231323
the resulting reduced order system. 0 <= nr <= n.
13241324
Default is None.
1325-
tol1 : double precision, optional
1325+
tol1 : float, optional
13261326
If ordsel = 'A', tol1 contains the tolerance for
13271327
determining the order of reduced system.
13281328
For model reduction, the recommended value is
@@ -1338,7 +1338,7 @@ def ab09nd(dico,job,equil,n,m,p,A,B,C,D,alpha=None,nr=None,tol1=0,tol2=0,ldwork=
13381338
of the alpha-stable part.
13391339
If ordsel = 'F', the value of tol1 is ignored.
13401340
Default is `0.0`.
1341-
tol2 : double precision, optional
1341+
tol2 : float, optional
13421342
The tolerance for determining the order of a minimal
13431343
realization of the alpha-stable part of the given system.
13441344
The recommended value is tol2 = ns*eps*hnorm(As,Bs,Cs).
@@ -1670,7 +1670,7 @@ def ab13ed(n, A, tol = 9.0):
16701670
----------
16711671
n : int
16721672
The order of the matrix A. ``n >= 0.``
1673-
A : (n,n) array_like
1673+
A : (n, n) array_like
16741674
The leading n-by-n part of this array must contain the matrix A.
16751675
tol : float, optional
16761676
Specifies the accuracy with which low and high approximate

0 commit comments

Comments
 (0)