Skip to content

Commit

Permalink
Update docstrings, add SlycotParameterError and other fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
KybernetikJo committed Aug 28, 2023
1 parent b9af86b commit 273b9fc
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions slycot/transform.py
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,6 @@ def tb03ad(n,m,p,A,B,C,D,leri,equil='N',tol=0.0,ldwork=None):
:info == 2:
A singular matrix was encountered during the
computation of P(s).
"""
hidden = ' (hidden by the wrapper)'
arg_list = ['leri', 'equil', 'n', 'm', 'P', 'A', 'LDA'+hidden, 'B',
Expand Down Expand Up @@ -495,22 +494,16 @@ def tb05ad(n, m, p, jomega, A, B, C, job='NG'):
http://www.netlib.org/lapack/explore-3.1.1-html/dgehrd.f.html
However, it does not apparently contain information on P, the
matrix used in the balancing procedure.
Bt : The matrix B transformed according to
Bt = Q^T * P^-1 * B.
Ct : The matrix C transformed according to
Ct = C * P * Q
rcond : RCOND contains an estimate of the reciprocal of the
condition number of matrix H with respect to inversion, where
H = (j*freq * I - A)
g_jw : complex p-by-m array, which contains the frequency response
matrix G(freq).
ev : Eigenvalues of the matrix A.
hinvb : complex n-by-m array, which contains the product
-1
H B.
Expand All @@ -523,20 +516,16 @@ def tb05ad(n, m, p, jomega, A, B, C, job='NG'):
The lower triangle is not zero. It containts info on the
orthoganal transformation. See docs for linpack DGEHRD()
http://www.netlib.org/lapack/explore-3.1.1-html/dgehrd.f.html
Bt : The matrix B transformed according to
Bt = Q^T * B.
Ct : The matrix C transformed according to
Ct = C * Q
g_jw : complex array with dim p-by-m which contains the frequency
response matrix G(freq).
hinvb : complex array with dimension p-by-m.
This array contains the
-1
product H B.
if job = 'NH'
-------------
g_jw : complex p-by-m array which contains the frequency
Expand All @@ -546,7 +535,6 @@ def tb05ad(n, m, p, jomega, A, B, C, job='NG'):
-1
product H B.
Raises
------
SlycotParameterError
Expand Down Expand Up @@ -678,6 +666,8 @@ 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

0 comments on commit 273b9fc

Please sign in to comment.