Skip to content

Commit e59f126

Browse files
committed
change ab13md docstring sections to numpydoc style
1 parent 95b2d11 commit e59f126

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

‎slycot/analysis.py‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1785,46 +1785,48 @@ def ab13md(Z, nblock, itype, x=None):
17851785
17861786
Parameters
17871787
----------
1788-
Z : (n,n) complex array
1788+
Z : (n, n) array_like
17891789
Matrix to find structured singular value upper bound of
17901790
1791-
nblock : (m,) integer array
1791+
nblock : (m,) array_like
17921792
The size of the block diagonals of the uncertainty structure;
17931793
i.e., nblock(i)=p means that the ith block is pxp.
17941794
1795-
itype : (m,) integer array
1795+
itype : (m,) array_like
17961796
The type of each block diagonal uncertainty defined in nblock.
17971797
itype(i)==1 means that the ith block is real, while itype(i)==2
17981798
means the the ith block is complex. Real blocks must be 1x1,
17991799
i.e., if itype(i)==1, nblock(i) must be 1.
18001800
1801-
x : (q,) real array or None
1801+
x : (q,) array_like, optional
18021802
If not None, must be the output of a previous call to ab13md.
18031803
The previous call must have been with the same values of n,
18041804
nblock, and itype; and the previous call's Z should be "close"
18051805
to the current call's Z.
18061806
18071807
q is determined by the block structure; see SLICOT AB13MD for
1808-
details.
1808+
details. Default is None.
18091809
18101810
Returns
18111811
-------
18121812
mubound : non-negative real scalar
18131813
Upper bound on structure singular value for given arguments
18141814
1815-
d, g : (n,) real arrays
1815+
d, g : (n,) ndarray
18161816
Real arrays such that if D=np.diag(g), G=np.diag(G), and ZH = Z.T.conj(), then
18171817
ZH @ D**2 @ Z + 1j * (G@Z - ZH@G) - mu**2 * D**2
18181818
will be negative semi-definite.
18191819
1820-
xout : (q,) real array
1820+
xout : (q,) ndarray
18211821
For use as ``x`` argument in subsequent call to ``ab13md``.
18221822
18231823
For scalar Z and real uncertainty (ntype=1, itype=1), returns 0
18241824
instead of abs(Z).
18251825
18261826
Raises
18271827
------
1828+
SlycotParameterError
1829+
:info = -i: the i-th argument had an illegal value
18281830
SlycotArithmeticError
18291831
:info = 1: Block sizes must be positive
18301832
:info = 2: Block sizes must sum to n

0 commit comments

Comments
 (0)