home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / complib / sgtrfs.z / sgtrfs
Encoding:
Text File  |  1998-10-30  |  5.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))                                                          SSSSGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGTRFS - improve the computed solution to a system of linear equations
  10.      when the coefficient matrix is tridiagonal, and provides error bounds and
  11.      backward error estimates for the solution
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE SGTRFS( TRANS, N, NRHS, DL, D, DU, DLF, DF, DUF, DU2, IPIV, B,
  15.                         LDB, X, LDX, FERR, BERR, WORK, IWORK, INFO )
  16.  
  17.          CHARACTER      TRANS
  18.  
  19.          INTEGER        INFO, LDB, LDX, N, NRHS
  20.  
  21.          INTEGER        IPIV( * ), IWORK( * )
  22.  
  23.          REAL           B( LDB, * ), BERR( * ), D( * ), DF( * ), DL( * ), DLF(
  24.                         * ), DU( * ), DU2( * ), DUF( * ), FERR( * ), WORK( *
  25.                         ), X( LDX, * )
  26.  
  27. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  28.      SGTRFS improves the computed solution to a system of linear equations
  29.      when the coefficient matrix is tridiagonal, and provides error bounds and
  30.      backward error estimates for the solution.
  31.  
  32.  
  33. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  34.      TRANS   (input) CHARACTER*1
  35.              Specifies the form of the system of equations:
  36.              = 'N':  A * X = B     (No transpose)
  37.              = 'T':  A**T * X = B  (Transpose)
  38.              = 'C':  A**H * X = B  (Conjugate transpose = Transpose)
  39.  
  40.      N       (input) INTEGER
  41.              The order of the matrix A.  N >= 0.
  42.  
  43.      NRHS    (input) INTEGER
  44.              The number of right hand sides, i.e., the number of columns of
  45.              the matrix B.  NRHS >= 0.
  46.  
  47.      DL      (input) REAL array, dimension (N-1)
  48.              The (n-1) subdiagonal elements of A.
  49.  
  50.      D       (input) REAL array, dimension (N)
  51.              The diagonal elements of A.
  52.  
  53.      DU      (input) REAL array, dimension (N-1)
  54.              The (n-1) superdiagonal elements of A.
  55.  
  56.      DLF     (input) REAL array, dimension (N-1)
  57.              The (n-1) multipliers that define the matrix L from the LU
  58.              factorization of A as computed by SGTTRF.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))                                                          SSSSGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      DF      (input) REAL array, dimension (N)
  75.              The n diagonal elements of the upper triangular matrix U from the
  76.              LU factorization of A.
  77.  
  78.      DUF     (input) REAL array, dimension (N-1)
  79.              The (n-1) elements of the first superdiagonal of U.
  80.  
  81.      DU2     (input) REAL array, dimension (N-2)
  82.              The (n-2) elements of the second superdiagonal of U.
  83.  
  84.      IPIV    (input) INTEGER array, dimension (N)
  85.              The pivot indices; for 1 <= i <= n, row i of the matrix was
  86.              interchanged with row IPIV(i).  IPIV(i) will always be either i
  87.              or i+1; IPIV(i) = i indicates a row interchange was not required.
  88.  
  89.      B       (input) REAL array, dimension (LDB,NRHS)
  90.              The right hand side matrix B.
  91.  
  92.      LDB     (input) INTEGER
  93.              The leading dimension of the array B.  LDB >= max(1,N).
  94.  
  95.      X       (input/output) REAL array, dimension (LDX,NRHS)
  96.              On entry, the solution matrix X, as computed by SGTTRS.  On exit,
  97.              the improved solution matrix X.
  98.  
  99.      LDX     (input) INTEGER
  100.              The leading dimension of the array X.  LDX >= max(1,N).
  101.  
  102.      FERR    (output) REAL array, dimension (NRHS)
  103.              The estimated forward error bound for each solution vector X(j)
  104.              (the j-th column of the solution matrix X).  If XTRUE is the true
  105.              solution corresponding to X(j), FERR(j) is an estimated upper
  106.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  107.              divided by the magnitude of the largest element in X(j).  The
  108.              estimate is as reliable as the estimate for RCOND, and is almost
  109.              always a slight overestimate of the true error.
  110.  
  111.      BERR    (output) REAL array, dimension (NRHS)
  112.              The componentwise relative backward error of each solution vector
  113.              X(j) (i.e., the smallest relative change in any element of A or B
  114.              that makes X(j) an exact solution).
  115.  
  116.      WORK    (workspace) REAL array, dimension (3*N)
  117.  
  118.      IWORK   (workspace) INTEGER array, dimension (N)
  119.  
  120.      INFO    (output) INTEGER
  121.              = 0:  successful exit
  122.              < 0:  if INFO = -i, the i-th argument had an illegal value
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))                                                          SSSSGGGGTTTTRRRRFFFFSSSS((((3333FFFF))))
  137.  
  138.  
  139.  
  140. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  141.      ITMAX is the maximum number of steps of iterative refinement.
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.