Skip to content

Commit 5ff92fd

Browse files
committed
Remove generic message for SlycotParameterError in docstring
1 parent 9cddda4 commit 5ff92fd

File tree

1 file changed

+0
-48
lines changed

1 file changed

+0
-48
lines changed

slycot/transform.py

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,6 @@ def tb01id(n,m,p,maxred,a,b,c,job='A'):
9292
scale : rank-1 array('d') with bounds (n)
9393
The scaling factors applied to S. If D(j) is the scaling factor
9494
applied to row and column j, then scale(j) = D(j), for j = 1,...,n.
95-
96-
Raises
97-
------
98-
SlycotParameterError
99-
:info = -i: the i-th argument had an illegal value;
10095
"""
10196
hidden = ' (hidden by the wrapper)'
10297
arg_list = ['job', 'N', 'M', 'P', 'maxred', 'A', 'LDA'+hidden, 'B',
@@ -172,11 +167,6 @@ def tb01pd(n, m, p, A, B, C, job='M', equil='S', tol=1e-8, ldwork=None):
172167
(Ar,Br,Cr) of a minimal, controllable, or observable
173168
realization for the original system, depending on
174169
JOB = 'M', JOB = 'C', or JOB = 'O'.
175-
176-
Raises
177-
------
178-
SlycotParameterError
179-
:info = -i: the i-th argument had an illegal value
180170
"""
181171
hidden = ' (hidden by the wrapper)'
182172
arg_list = ['job', 'equil', 'n','m','p','A','lda'+hidden,'B','ldb'+hidden,
@@ -302,8 +292,6 @@ def tb03ad(n,m,p,A,B,C,D,leri,equil='N',tol=0.0,ldwork=None):
302292
303293
Raises
304294
------
305-
SlycotParameterError
306-
:info = -i: the i-th argument had an illegal value;
307295
SlycotArithmeticError
308296
:info == 1:
309297
A singular matrix was encountered during the
@@ -382,11 +370,6 @@ def tb04ad(n,m,p,A,B,C,D,tol1=0.0,tol2=0.0,ldwork=None):
382370
array of denominator coefficients
383371
ucoeff : (p, m, max(index)+1) ndarray
384372
array of numerator coefficients
385-
386-
Raises
387-
------
388-
SlycotParameterError
389-
:info = -i: the i-th argument had an illegal value
390373
"""
391374
hidden = ' (hidden by the wrapper)'
392375
arg_list = ['rowcol','n','m','p','A','lda'+hidden,'B','ldb'+hidden,'C','ldc'+hidden,'D', 'ldd'+hidden,
@@ -537,8 +520,6 @@ def tb05ad(n, m, p, jomega, A, B, C, job='NG'):
537520
538521
Raises
539522
------
540-
SlycotParameterError
541-
:info = -i: the i-th argument had an illegal value
542523
SlycotArithmeticError
543524
:info = 1:
544525
More than {n30} (30*`n`) iterations were required to isolate the
@@ -666,8 +647,6 @@ def td04ad(rowcol,m,p,index,dcoeff,ucoeff,tol=0.0,ldwork=None):
666647
667648
Raises
668649
------
669-
SlycotParameterError
670-
:info = -i: the i-th argument had an illegal value;
671650
SlycotArithmeticError
672651
:info > 0:
673652
i={info} is the first index of `dcoeff` for which
@@ -805,8 +784,6 @@ def tc04ad(m,p,index,pcoeff,qcoeff,leri,ldwork=None):
805784
806785
Raises
807786
------
808-
SlycotParameterError
809-
:info = -i: the i-th argument had an illegal value
810787
SlycotArithmeticError
811788
:info == 1 and leri = 'L':
812789
P(s) is not row proper
@@ -875,11 +852,6 @@ def tc01od(m,p,indlin,pcoeff,qcoeff,leri):
875852
qcoeff : (max(m,p), max(m,p), indlim) ndarray
876853
On exit, the leading m-by-p-by-indlim part of the array contains
877854
the coefficients of the numerator matrix Q'(s) of the dual system.
878-
879-
Raises
880-
------
881-
SlycotParameterError
882-
:info = -i: the i-th argument had an illegal value
883855
"""
884856
hidden = ' (hidden by the wrapper)'
885857
arg_list = ['leri', 'M', 'P', 'indlim', 'pcoeff', 'LDPCO1'+hidden,
@@ -930,11 +902,6 @@ def tf01md(n,m,p,N,A,B,C,D,u,x0):
930902
Final state, at time n+1.
931903
y : (p, n) ndarray
932904
Output signal.
933-
934-
Raises
935-
------
936-
SlycotParameterError
937-
:info = -i: the i-th argument had an illegal value
938905
"""
939906
hidden = ' (hidden by the wrapper)'
940907
arg_list = ['n','m','p','ny','A','lda'+hidden,'B','ldb'+hidden,
@@ -980,11 +947,6 @@ def tf01rd(n,m,p,N,A,B,C,ldwork=None):
980947
H : (p, N*m) ndarray
981948
H[:,(k-1)*m : k*m] contains the k-th Markov parameter,
982949
for k = 1,2...N.
983-
984-
Raises
985-
------
986-
SlycotParameterError
987-
:info = -i: the i-th argument had an illegal value
988950
"""
989951
hidden = ' (hidden by the wrapper)'
990952
arg_list = ['n','m','p','N','A','lda'+hidden,'B','ldb'+hidden,'C',
@@ -1088,11 +1050,6 @@ def tg01ad(l,n,m,p,A,E,B,C,thresh=0.0,job='A'):
10881050
The scaling factors applied to S from right. If Dr(j) is
10891051
the scaling factor applied to column j, then
10901052
SCALE(j) = Dr(j), for j = 1,...,N.
1091-
1092-
Raises
1093-
------
1094-
SlycotParameterError
1095-
:info = -i: the i-th argument had an illegal value
10961053
"""
10971054

10981055
hidden = ' (hidden by the wrapper)'
@@ -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
12611218
matrix A22, and thus also the order of the invertible
12621219
upper triangular submatrix Ar.
12631220
If JOBA = 'N', then RNKA22 is not referenced.
1264-
1265-
Raises
1266-
------
1267-
SlycotParameterError
1268-
:info = -i: the i-th argument had an illegal value
12691221
"""
12701222

12711223
hidden = ' (hidden by the wrapper)'

0 commit comments

Comments
 (0)