Skip to content

Commit

Permalink
Remove generic message for SlycotParameterError in docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
KybernetikJo committed Jan 5, 2024
1 parent 9cddda4 commit 5ff92fd
Showing 1 changed file with 0 additions and 48 deletions.
48 changes: 0 additions & 48 deletions slycot/transform.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,6 @@ def tb01id(n,m,p,maxred,a,b,c,job='A'):
scale : rank-1 array('d') with bounds (n)
The scaling factors applied to S. If D(j) is the scaling factor
applied to row and column j, then scale(j) = D(j), for j = 1,...,n.
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value;
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['job', 'N', 'M', 'P', 'maxred', 'A', 'LDA'+hidden, 'B',
Expand Down Expand Up @@ -172,11 +167,6 @@ def tb01pd(n, m, p, A, B, C, job='M', equil='S', tol=1e-8, ldwork=None):
(Ar,Br,Cr) of a minimal, controllable, or observable
realization for the original system, depending on
JOB = 'M', JOB = 'C', or JOB = 'O'.
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['job', 'equil', 'n','m','p','A','lda'+hidden,'B','ldb'+hidden,
Expand Down Expand Up @@ -302,8 +292,6 @@ def tb03ad(n,m,p,A,B,C,D,leri,equil='N',tol=0.0,ldwork=None):
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value;
SlycotArithmeticError
:info == 1:
A singular matrix was encountered during the
Expand Down Expand Up @@ -382,11 +370,6 @@ def tb04ad(n,m,p,A,B,C,D,tol1=0.0,tol2=0.0,ldwork=None):
array of denominator coefficients
ucoeff : (p, m, max(index)+1) ndarray
array of numerator coefficients
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['rowcol','n','m','p','A','lda'+hidden,'B','ldb'+hidden,'C','ldc'+hidden,'D', 'ldd'+hidden,
Expand Down Expand Up @@ -537,8 +520,6 @@ def tb05ad(n, m, p, jomega, A, B, C, job='NG'):
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
SlycotArithmeticError
:info = 1:
More than {n30} (30*`n`) iterations were required to isolate the
Expand Down Expand Up @@ -666,8 +647,6 @@ def td04ad(rowcol,m,p,index,dcoeff,ucoeff,tol=0.0,ldwork=None):
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value;
SlycotArithmeticError
:info > 0:
i={info} is the first index of `dcoeff` for which
Expand Down Expand Up @@ -805,8 +784,6 @@ def tc04ad(m,p,index,pcoeff,qcoeff,leri,ldwork=None):
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
SlycotArithmeticError
:info == 1 and leri = 'L':
P(s) is not row proper
Expand Down Expand Up @@ -875,11 +852,6 @@ def tc01od(m,p,indlin,pcoeff,qcoeff,leri):
qcoeff : (max(m,p), max(m,p), indlim) ndarray
On exit, the leading m-by-p-by-indlim part of the array contains
the coefficients of the numerator matrix Q'(s) of the dual system.
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['leri', 'M', 'P', 'indlim', 'pcoeff', 'LDPCO1'+hidden,
Expand Down Expand Up @@ -930,11 +902,6 @@ def tf01md(n,m,p,N,A,B,C,D,u,x0):
Final state, at time n+1.
y : (p, n) ndarray
Output signal.
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['n','m','p','ny','A','lda'+hidden,'B','ldb'+hidden,
Expand Down Expand Up @@ -980,11 +947,6 @@ def tf01rd(n,m,p,N,A,B,C,ldwork=None):
H : (p, N*m) ndarray
H[:,(k-1)*m : k*m] contains the k-th Markov parameter,
for k = 1,2...N.
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['n','m','p','N','A','lda'+hidden,'B','ldb'+hidden,'C',
Expand Down Expand Up @@ -1088,11 +1050,6 @@ def tg01ad(l,n,m,p,A,E,B,C,thresh=0.0,job='A'):
The scaling factors applied to S from right. If Dr(j) is
the scaling factor applied to column j, then
SCALE(j) = Dr(j), for j = 1,...,N.
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
"""

hidden = ' (hidden by the wrapper)'
Expand Down Expand Up @@ -1261,11 +1218,6 @@ def tg01fd(l,n,m,p,A,E,B,C,Q=None,Z=None,compq='N',compz='N',joba='N',tol=0.0,ld
matrix A22, and thus also the order of the invertible
upper triangular submatrix Ar.
If JOBA = 'N', then RNKA22 is not referenced.
Raises
------
SlycotParameterError
:info = -i: the i-th argument had an illegal value
"""

hidden = ' (hidden by the wrapper)'
Expand Down

0 comments on commit 5ff92fd

Please sign in to comment.