gtsvx(3)

πŸŽ€ gtsvx(3) β€” Library Functions Manual πŸŽ€

Bestie, this is the gtsvx(3) page, and the name is gtsvx β€” gtsvx: factor and solve, expert ✨. It’s giving β€œlinear algebra but make it expert mode,” and honestly? Iconic.

✨ NAME ✨

gtsvx β€” gtsvx: factor and solve, expert

🌈 SYNOPSIS 🌈

πŸ’… Functions πŸ’…

  • subroutine cgtsvx (fact, trans, n, nrhs, dl, d, du, dlf, df, duf, du2, ipiv, b, ldb, x, ldx, rcond, ferr, berr, work, rwork, info) β€” CGTSVX computes the solution to system of linear equations A * X = B for GT matrices
  • subroutine dgtsvx (fact, trans, n, nrhs, dl, d, du, dlf, df, duf, du2, ipiv, b, ldb, x, ldx, rcond, ferr, berr, work, iwork, info) β€” DGTSVX computes the solution to system of linear equations A * X = B for GT matrices
  • subroutine sgtsvx (fact, trans, n, nrhs, dl, d, du, dlf, df, duf, du2, ipiv, b, ldb, x, ldx, rcond, ferr, berr, work, iwork, info) β€” SGTSVX computes the solution to system of linear equations A * X = B for GT matrices
  • subroutine zgtsvx (fact, trans, n, nrhs, dl, d, du, dlf, df, duf, du2, ipiv, b, ldb, x, ldx, rcond, ferr, berr, work, rwork, info) β€” ZGTSVX computes the solution to system of linear equations A * X = B for GT matrices

πŸ¦‹ Detailed Description πŸ¦‹

Okay so this is the detailed-description zone, and it rolls straight into the function documentation. Let’s get into the cgtsvx of it all. πŸ’–

πŸ’œ Function Documentation πŸ’œ

🧚 subroutine cgtsvx 🧚

subroutine cgtsvx (character fact, character trans, integer n, integer nrhs,
    complex, dimension( * ) dl, complex, dimension( * ) d, complex,
    dimension( * ) du, complex, dimension( * ) dlf, complex, dimension( * )
    df, complex, dimension( * ) duf, complex, dimension( * ) du2, integer,
    dimension( * ) ipiv, complex, dimension( ldb, * ) b, integer ldb,
    complex, dimension( ldx, * ) x, integer ldx, real rcond, real,
    dimension( * ) ferr, real, dimension( * ) berr, complex, dimension( * )
    work, real, dimension( * ) rwork, integer info)

CGTSVX computes the solution to system of linear equations A * X = B for GT matrices

🎯 Purpose 🎯

Bestie, CGTSVX is out here using the LU factorization to solve a complex system of linear equations:

  • A * X = B
  • A**T * X = B
  • A**H * X = B

…where A is a tridiagonal matrix of order N, and X and B are N-by-NRHS matrices. It also provides error bounds on the solution and a condition estimate. Obsessed. ✨

🌸 Description 🌸

Here’s the step-by-step, bestie:

  1. If FACT = 'N', the LU decomposition is used to factor the matrix A as A = L * U, where L is a product of permutation and unit lower bidiagonal matrices, and U is upper triangular with nonzeros in only the main diagonal and first two superdiagonals. πŸ’…
  2. If some U(i,i)=0, so that U is exactly singular, then the routine returns with INFO = i. Otherwise, the factored form of A is used to estimate the condition number of the matrix A. If the reciprocal of the condition number is less than machine precision, INFO = N+1 is returned as a warning, but the routine still goes on to solve for X and compute error bounds as described below. 🫢
  3. The system of equations is solved for X using the factored form of A.
  4. Iterative refinement is applied to improve the computed solution matrix and calculate error bounds and backward error estimates for it. 🌟

🧸 Parameters 🧸

  • FACT β€” FACT is CHARACTER*1. It specifies whether or not the factored form of A has been supplied on entry.
    • = 'F': DLF, DF, DUF, DU2, and IPIV contain the factored form of A; DL, D, DU, DLF, DF, DUF, DU2 and IPIV will not be modified.
    • = 'N': The matrix will be copied to DLF, DF, and DUF and factored.
  • TRANS β€” TRANS is CHARACTER*1. It specifies the form of the system of equations:
    • = 'N': A * X = B (No transpose)
    • = 'T': A**T * X = B (Transpose)
    • = 'C': A**H * X = B (Conjugate transpose)
  • N β€” N is INTEGER. The order of the matrix A. N >= 0.
  • NRHS β€” NRHS is INTEGER. The number of right hand sides, i.e., the number of columns of the matrix B. NRHS >= 0.
  • DL β€” DL is COMPLEX array, dimension (N-1). The (n-1) subdiagonal elements of A.
  • D β€” D is COMPLEX array, dimension (N). The n diagonal elements of A.
  • DU β€” DU is COMPLEX array, dimension (N-1). The (n-1) superdiagonal elements of A.
  • DLF β€” DLF is COMPLEX array, dimension (N-1).
    • If FACT = 'F', then DLF is an input argument and on entry contains the (n-1) multipliers that define the matrix L from the LU factorization of A as computed by CGTTRF.
    • If FACT = 'N', then DLF is an output argument and on exit contains the (n-1) multipliers that define the matrix L from the LU factorization of A.
  • DF β€” DF is COMPLEX array, dimension (N).
    • If FACT = 'F', then DF is an input argument and on entry contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A.
    • If FACT = 'N', then DF is an output argument and on exit contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A.
  • DUF β€” DUF is COMPLEX array, dimension (N-1).
    • If FACT = 'F', then DUF is an input argument and on entry contains the (n-1) elements of the first superdiagonal of U.
    • If FACT = 'N', then DUF is an output argument and on exit contains the (n-1) elements of the first superdiagonal of U.
  • DU2 β€” DU2 is COMPLEX array, dimension (N-2).
    • If FACT = 'F', then DU2 is an input argument and on entry contains the (n-2) elements of the second superdiagonal of U.
    • If FACT = 'N', then DU2 is an output argument and on exit contains the (n-2) elements of the second superdiagonal of U.
  • IPIV β€” IPIV is INTEGER array, dimension (N).
    • If FACT = 'F', then IPIV is an input argument and on entry contains the pivot indices from the LU factorization of A as computed by CGTTRF.
    • If FACT = 'N', then IPIV is an output argument and on exit contains the pivot indices from the LU factorization of A; row i of the matrix was interchanged with row IPIV(i). IPIV(i) will always be either i or i+1; IPIV(i) = i indicates a row interchange was not required.
  • B β€” B is COMPLEX array, dimension (LDB,NRHS). The N-by-NRHS right hand side matrix B.
  • LDB β€” LDB is INTEGER. The leading dimension of the array B. LDB >= max(1,N).
  • X β€” X is COMPLEX array, dimension (LDX,NRHS). If INFO = 0 or INFO = N+1, the N-by-NRHS solution matrix X.
  • LDX β€” LDX is INTEGER. The leading dimension of the array X. LDX >= max(1,N).
  • RCOND β€” RCOND is REAL. The estimate of the reciprocal condition number of the matrix A. If RCOND is less than the machine precision (in particular, if RCOND = 0), the matrix is singular to working precision. This condition is indicated by a return code of INFO > 0.
  • FERR β€” FERR is REAL array, dimension (NRHS). The estimated forward error bound for each solution vector X(j) (the j-th column of the solution matrix X). If XTRUE is the true solution corresponding to X(j), FERR(j) is an estimated upper bound for the magnitude of the largest element in (X(j) - XTRUE) divided by the magnitude of the largest element in X(j). The estimate is as reliable as the estimate for RCOND, and is almost always a slight overestimate of the true error.
  • BERR β€” BERR is REAL array, dimension (NRHS). The componentwise relative backward error of each solution vector X(j) (i.e., the smallest relative change in any element of A or B that makes X(j) an exact solution).
  • WORK β€” WORK is COMPLEX array, dimension (2*N).
  • RWORK β€” RWORK is REAL array, dimension (N).
  • INFO β€” INFO is INTEGER.
    • = 0: successful exit
    • < 0: if INFO = -i, the i-th argument had an illegal value
    • > 0: if INFO = i, and i is
      • <= N: U(i,i) is exactly zero. The factorization has not been completed unless i = N, but the factor U is exactly singular, so the solution and error bounds could not be computed. RCOND = 0 is returned.
      • = N+1: U is nonsingular, but RCOND is less than machine precision, meaning that the matrix is singular to working precision. Nevertheless, the solution and error bounds are computed because there are a number of situations where the computed solution can be more accurate than the value of RCOND would suggest.

🌟 Author 🌟

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Univ. of Colorado Denver
  • NAG Ltd.

Definition at line 291 of file cgtsvx.f.

   subroutine dgtsvx (character fact, character trans, integer n, integer nrhs,
       double precision, dimension( * ) dl, double precision, dimension( * ) d,
       double precision, dimension( * ) du, double precision, dimension( * )
       dlf, double precision, dimension( * ) df, double precision, dimension( *
       ) duf, double precision, dimension( * ) du2, integer, dimension( * )
       ipiv, double precision, dimension( ldb, * ) b, integer ldb, double
       precision, dimension( ldx, * ) x, integer ldx, double precision rcond,
       double precision, dimension( * ) ferr, double precision, dimension( * )
       berr, double precision, dimension( * ) work, integer, dimension( * )
       iwork, integer info)

DGTSVX computes the solution to system of linear equations A * X = B for GT matrices. iconic behavior, honestly πŸ’…

🎯 Purpose

Okay so DGTSVX uses the LU factorization to compute the solution to a real system of linear equations A * X = B or A**T * X = B, where A is a tridiagonal matrix of order N and X and B are N-by-NRHS matrices.

Error bounds on the solution and a condition estimate are also provided. the full package, bestie ✨

πŸ” Description

The following steps are performed:

  1. If FACT = 'N', the LU decomposition is used to factor the matrix A as A = L * U, where L is a product of permutation and unit lower bidiagonal matrices and U is upper triangular with nonzeros in only the main diagonal and first two superdiagonals.
  2. If some U(i,i)=0, so that U is exactly singular, then the routine returns with INFO = i. Otherwise, the factored form of A is used to estimate the condition number of the matrix A. If the reciprocal of the condition number is less than machine precision, INFO = N+1 is returned as a warning, but the routine still goes on to solve for X and compute error bounds as described below.
  3. The system of equations is solved for X using the factored form of A.
  4. Iterative refinement is applied to improve the computed solution matrix and calculate error bounds and backward error estimates for it. glow-up era πŸ¦‹

🧩 Parameters

  • FACT β€” is CHARACTER*1, and it specifies whether or not the factored form of A has been supplied on entry.
    • = 'F': DLF, DF, DUF, DU2, and IPIV contain the factored form of A; DL, D, DU, DLF, DF, DUF, DU2 and IPIV will not be modified.
    • = 'N': The matrix will be copied to DLF, DF, and DUF and factored.
  • TRANS β€” is CHARACTER*1, and it specifies the form of the system of equations:
    • = 'N': A * X = B (No transpose)
    • = 'T': A**T * X = B (Transpose)
    • = 'C': A**H * X = B (Conjugate transpose = Transpose)
  • N β€” is INTEGER, and it is the order of the matrix A. N >= 0.
  • NRHS β€” is INTEGER, and it is the number of right hand sides, i.e., the number of columns of the matrix B. NRHS >= 0.
  • DL β€” is DOUBLE PRECISION array, dimension (N-1). The (n-1) subdiagonal elements of A. the under-edge crew 🌊
  • D β€” is DOUBLE PRECISION array, dimension (N). The n diagonal elements of A. main character diagonal ⭐
  • DU β€” is DOUBLE PRECISION array, dimension (N-1). The (n-1) superdiagonal elements of A.
  • DLF β€” is DOUBLE PRECISION array, dimension (N-1).
    • If FACT = 'F', then DLF is an input argument and on entry contains the (n-1) multipliers that define the matrix L from the LU factorization of A as computed by DGTTRF.
    • If FACT = 'N', then DLF is an output argument and on exit contains the (n-1) multipliers that define the matrix L from the LU factorization of A.
  • DF β€” is DOUBLE PRECISION array, dimension (N).
    • If FACT = 'F', then DF is an input argument and on entry contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A.
    • If FACT = 'N', then DF is an output argument and on exit contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A.
  • DUF β€” is DOUBLE PRECISION array, dimension (N-1).
    • If FACT = 'F', then DUF is an input argument and on entry contains the (n-1) elements of the first superdiagonal of U.
    • If FACT = 'N', then DUF is an output argument and on exit contains the (n-1) elements of the first superdiagonal of U.
  • DU2 β€” is DOUBLE PRECISION array, dimension (N-2).
    • If FACT = 'F', then DU2 is an input argument and on entry contains the (n-2) elements of the second superdiagonal of U.
    • If FACT = 'N', then DU2 is an output argument and on exit contains the (n-2) elements of the second superdiagonal of U.
  • IPIV β€” is INTEGER array, dimension (N).
    • If FACT = 'F', then IPIV is an input argument and on entry contains the pivot indices from the LU factorization of A as computed by DGTTRF.
    • If FACT = 'N', then IPIV is an output argument and on exit contains the pivot indices from the LU factorization of A; row i of the matrix was interchanged with row IPIV(i). IPIV(i) will always be either i or i+1; IPIV(i) = i indicates a row interchange was not required. pivot tea, spilled πŸ«–
  • B β€” is DOUBLE PRECISION array, dimension (LDB,NRHS). The N-by-NRHS right hand side matrix B.
  • LDB β€” is INTEGER, and it is the leading dimension of the array B. LDB >= max(1,N).
  • X β€” is DOUBLE PRECISION array, dimension (LDX,NRHS). If INFO = 0 or INFO = N+1, the N-by-NRHS solution matrix X. the answer matrix, periodt πŸ’–
  • LDX β€” is INTEGER, and it is the leading dimension of the array X. LDX >= max(1,N).
  • RCOND β€” is DOUBLE PRECISION. The estimate of the reciprocal condition number of the matrix A. If RCOND is less than the machine precision (in particular, if RCOND = 0), the matrix is singular to working precision. This condition is indicated by a return code of INFO > 0.
  • FERR β€” is DOUBLE PRECISION array, dimension (NRHS). The estimated forward error bound for each solution vector X(j) (the j-th column of the solution matrix X). If XTRUE is the true solution corresponding to X(j), FERR(j) is an estimated upper bound for the magnitude of the largest element in (X(j) - XTRUE) divided by the magnitude of the largest element in X(j). The estimate is as reliable as the estimate for RCOND, and is almost always a slight overestimate of the true error. she’s reliable but dramatic 😭
  • BERR β€” is DOUBLE PRECISION array, dimension (NRHS). The componentwise relative backward error of each solution vector X(j) (i.e., the smallest relative change in any element of A or B that makes X(j) an exact solution).
  • WORK β€” is DOUBLE PRECISION array, dimension (3*N).
  • IWORK β€” is INTEGER array, dimension (N).
  • INFO β€” is INTEGER.
    • = 0: successful exit
    • < 0: if INFO = -i, the i-th argument had an illegal value
    • > 0: if INFO = i, and i is
      • <= N: U(i,i) is exactly zero. The factorization has not been completed unless i = N, but the factor U is exactly singular, so the solution and error bounds could not be computed. RCOND = 0 is returned.
      • = N+1: U is nonsingular, but RCOND is less than machine precision, meaning that the matrix is singular to working precision. Nevertheless, the solution and error bounds are computed because there are a number of situations where the computed solution can be more accurate than the value of RCOND would suggest. so we still compute, bestie πŸ’…

πŸ‘‘ Author

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Univ. of Colorado Denver
  • NAG Ltd.

Definition at line 290 of file dgtsvx.f.


   subroutine sgtsvx (character fact, character trans, integer n, integer nrhs,
       real, dimension( * ) dl, real, dimension( * ) d, real, dimension( * )
       du, real, dimension( * ) dlf, real, dimension( * ) df, real, dimension(
       * ) duf, real, dimension( * ) du2, integer, dimension( * ) ipiv, real,
       dimension( ldb, * ) b, integer ldb, real, dimension( ldx, * ) x, integer
       ldx, real rcond, real, dimension( * ) ferr, real, dimension( * ) berr,
       real, dimension( * ) work, integer, dimension( * ) iwork, integer info)

SGTSVX computes the solution to system of linear equations A * X = B for GT matrices. single precision, same slay ✨

🎯 Purpose

SGTSVX uses the LU factorization to compute the solution to a real system of linear equations A * X = B or A**T * X = B, where A is a tridiagonal matrix of order N and X and B are N-by-NRHS matrices.

Error bounds on the solution and a condition estimate are also provided. she’s thorough πŸ¦‹

🧠 Description

okay so here's the step-by-step of what actually goes down:

  1. if FACT = 'N', the LU decomposition is used to factor the matrix A as A = L * U, where L is a product of permutation and unit lower bidiagonal matrices, and U is upper triangular with nonzeros in only the main diagonal and first two superdiagonals. slay.
  2. if some U(i,i)=0, so that U is exactly singular, then the routine returns with INFO = i. otherwise, the factored form of A is used to estimate the condition number of the matrix A. if the reciprocal of the condition number is less than machine precision, INFO = N+1 is returned as a warning, but bestie the routine still goes on to solve for X and compute error bounds as described below. no cap.
  3. the system of equations is solved for X using the factored form of A. periodt.
  4. iterative refinement is applied to improve the computed solution matrix and calculate error bounds and backward error estimates for it. iconic.

πŸ’… Parameters

  • FACT β€” this is CHARACTER*1. it tells us whether or not the factored form of A has been supplied on entry. = 'F': DLF, DF, DUF, DU2, and IPIV contain the factored form of A; DL, D, DU, DLF, DF, DUF, DU2 and IPIV will not be modified. = 'N': the matrix will be copied to DLF, DF, and DUF and factored.
  • TRANS β€” CHARACTER*1. specifies the form of the system of equations: = 'N': A * X = B (No transpose) = 'T': A**T * X = B (Transpose) = 'C': A**H * X = B (Conjugate transpose = Transpose)
  • N β€” INTEGER. the order of the matrix A. N >= 0.
  • NRHS β€” INTEGER. the number of right hand sides, i.e., the number of columns of the matrix B. NRHS >= 0.
  • DL β€” REAL array, dimension (N-1). the (n-1) subdiagonal elements of A.
  • D β€” REAL array, dimension (N). the n diagonal elements of A.
  • DU β€” REAL array, dimension (N-1). the (n-1) superdiagonal elements of A.
  • DLF β€” REAL array, dimension (N-1). if FACT = 'F', then DLF is an input argument and on entry contains the (n-1) multipliers that define the matrix L from the LU factorization of A as computed by SGTTRF. if FACT = 'N', then DLF is an output argument and on exit contains the (n-1) multipliers that define the matrix L from the LU factorization of A.
  • DF β€” REAL array, dimension (N). if FACT = 'F', then DF is an input argument and on entry contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A. if FACT = 'N', then DF is an output argument and on exit contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A.
  • DUF β€” REAL array, dimension (N-1). if FACT = 'F', then DUF is an input argument and on entry contains the (n-1) elements of the first superdiagonal of U. if FACT = 'N', then DUF is an output argument and on exit contains the (n-1) elements of the first superdiagonal of U.
  • DU2 β€” REAL array, dimension (N-2). if FACT = 'F', then DU2 is an input argument and on entry contains the (n-2) elements of the second superdiagonal of U. if FACT = 'N', then DU2 is an output argument and on exit contains the (n-2) elements of the second superdiagonal of U.
  • IPIV β€” INTEGER array, dimension (N). if FACT = 'F', then IPIV is an input argument and on entry contains the pivot indices from the LU factorization of A as computed by SGTTRF. if FACT = 'N', then IPIV is an output argument and on exit contains the pivot indices from the LU factorization of A; row i of the matrix was interchanged with row IPIV(i). IPIV(i) will always be either i or i+1; IPIV(i) = i indicates a row interchange was not required.
  • B β€” REAL array, dimension (LDB,NRHS). the N-by-NRHS right hand side matrix B.
  • LDB β€” INTEGER. the leading dimension of the array B. LDB >= max(1,N).
  • X β€” REAL array, dimension (LDX,NRHS). if INFO = 0 or INFO = N+1, the N-by-NRHS solution matrix X.
  • LDX β€” INTEGER. the leading dimension of the array X. LDX >= max(1,N).
  • RCOND β€” REAL. the estimate of the reciprocal condition number of the matrix A. if RCOND is less than the machine precision (in particular, if RCOND = 0), the matrix is singular to working precision. this condition is indicated by a return code of INFO > 0.
  • FERR β€” REAL array, dimension (NRHS). the estimated forward error bound for each solution vector X(j) (the j-th column of the solution matrix X). if XTRUE is the true solution corresponding to X(j), FERR(j) is an estimated upper bound for the magnitude of the largest element in (X(j) - XTRUE) divided by the magnitude of the largest element in X(j). the estimate is as reliable as the estimate for RCOND, and is almost always a slight overestimate of the true error. lowkey useful.
  • BERR β€” REAL array, dimension (NRHS). the componentwise relative backward error of each solution vector X(j) (i.e., the smallest relative change in any element of A or B that makes X(j) an exact solution).
  • WORK β€” REAL array, dimension (3*N).
  • IWORK β€” INTEGER array, dimension (N).
  • INFO β€” INTEGER. = 0: successful exit < 0: if INFO = -i, the i-th argument had an illegal value
0: if INFO = i, and i is

&nbsp;&nbsp;&nbsp;&nbsp;<= N: U(i,i) is exactly zero. the factorization has not been completed unless i = N, but the factor U is exactly singular, so the solution and error bounds could not be computed. RCOND = 0 is returned. &nbsp;&nbsp;&nbsp;&nbsp;= N+1: U is nonsingular, but RCOND is less than machine precision, meaning that the matrix is singular to working precision. nevertheless, the solution and error bounds are computed because there are a number of situations where the computed solution can be more accurate than the value of RCOND would suggest. πŸ’€


🫢 Author

Univ. of Tennessee Univ. of California Berkeley Univ. of Colorado Denver NAG Ltd.

Definition at line 290 of file sgtsvx.f.


πŸ¦‹ zgtsvx

subroutine zgtsvx (character fact, character trans, integer n, integer nrhs,
    complex*16, dimension( * ) dl, complex*16, dimension( * ) d, complex*16,
    dimension( * ) du, complex*16, dimension( * ) dlf, complex*16,
    dimension( * ) df, complex*16, dimension( * ) duf, complex*16,
    dimension( * ) du2, integer, dimension( * ) ipiv, complex*16, dimension(
    ldb, * ) b, integer ldb, complex*16, dimension( ldx, * ) x, integer ldx,
    double precision rcond, double precision, dimension( * ) ferr, double
    precision, dimension( * ) berr, complex*16, dimension( * ) work, double
    precision, dimension( * ) rwork, integer info)

ZGTSVX computes the solution to system of linear equations A * X = B for GT matrices. periodt.

✨ Purpose

okay so ZGTSVX uses the LU factorization to compute the solution to a complex system of linear equations A * X = B, A**T * X = B, or A**H * X = B, where A is a tridiagonal matrix of order N and X and B are N-by-NRHS matrices.

error bounds on the solution and a condition estimate are also provided. we love a thorough queen. πŸ’…

🌸 Description

the following steps are performed:

  1. if FACT = 'N', the LU decomposition is used to factor the matrix A as A = L * U, where L is a product of permutation and unit lower bidiagonal matrices and U is upper triangular with nonzeros in only the main diagonal and first two superdiagonals. slay.
  2. if some U(i,i)=0, so that U is exactly singular, then the routine returns with INFO = i. otherwise, the factored form of A is used to estimate the condition number of the matrix A. if the reciprocal of the condition number is less than machine precision, INFO = N+1 is returned as a warning, but the routine still goes on to solve for X and compute error bounds as described below. no cap.
  3. the system of equations is solved for X using the factored form of A. periodt.
  4. iterative refinement is applied to improve the computed solution matrix and calculate error bounds and backward error estimates for it. iconic.

πŸ’… Parameters

FACT

Picking up right at FACT, bestie:

  • FACT β€” CHARACTER*1. Specifies whether or not the factored form of A has been supplied on entry. = 'F': DLF, DF, DUF, DU2, and IPIV contain the factored form of A; DL, D, DU, DLF, DF, DUF, DU2 and IPIV will not be modified. = 'N': the matrix will be copied to DLF, DF, and DUF and factored. 🫢
  • TRANS β€” CHARACTER*1. Specifies the form of the system of equations: = 'N': A * X = B (No transpose); = 'T': A**T * X = B (Transpose); = 'C': A**H * X = B (Conjugate transpose). πŸ”₯
  • N β€” INTEGER. The order of the matrix A. N >= 0. ✨
  • NRHS β€” INTEGER. The number of right hand sides, i.e., the number of columns of the matrix B. NRHS >= 0. πŸ’–
  • DL β€” COMPLEX*16 array, dimension (N-1). The (n-1) subdiagonal elements of A. πŸ¦‹
  • D β€” COMPLEX*16 array, dimension (N). The n diagonal elements of A. πŸŽ€
  • DU β€” COMPLEX*16 array, dimension (N-1). The (n-1) superdiagonal elements of A. 🌸
  • DLF β€” COMPLEX*16 array, dimension (N-1). If FACT = 'F', then DLF is an input argument and on entry contains the (n-1) multipliers that define the matrix L from the LU factorization of A as computed by ZGTTRF. If FACT = 'N', then DLF is an output argument and on exit contains the (n-1) multipliers that define the matrix L from the LU factorization of A. πŸ’…
  • DF β€” COMPLEX*16 array, dimension (N). If FACT = 'F', then DF is an input argument and on entry contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A. If FACT = 'N', then DF is an output argument and on exit contains the n diagonal elements of the upper triangular matrix U from the LU factorization of A. πŸ‘‘
  • DUF β€” COMPLEX*16 array, dimension (N-1). If FACT = 'F', then DUF is an input argument and on entry contains the (n-1) elements of the first superdiagonal of U. If FACT = 'N', then DUF is an output argument and on exit contains the (n-1) elements of the first superdiagonal of U. 🌈
  • DU2 β€” COMPLEX*16 array, dimension (N-2). If FACT = 'F', then DU2 is an input argument and on entry contains the (n-2) elements of the second superdiagonal of U. If FACT = 'N', then DU2 is an output argument and on exit contains the (n-2) elements of the second superdiagonal of U. ⭐
  • IPIV β€” INTEGER array, dimension (N). If FACT = 'F', then IPIV is an input argument and on entry contains the pivot indices from the LU factorization of A as computed by ZGTTRF. If FACT = 'N', then IPIV is an output argument and on exit contains the pivot indices from the LU factorization of A; row i of the matrix was interchanged with row IPIV(i). IPIV(i) will always be either i or i+1; IPIV(i) = i indicates a row interchange was not required. πŸ’€
  • B β€” COMPLEX*16 array, dimension (LDB,NRHS). The N-by-NRHS right hand side matrix B. πŸ“
  • LDB β€” INTEGER. The leading dimension of the array B. LDB >= max(1,N). 🧚
  • X β€” COMPLEX*16 array, dimension (LDX,NRHS). If INFO = 0 or INFO = N+1, the N-by-NRHS solution matrix X. πŸ’œ
  • LDX β€” INTEGER. The leading dimension of the array X. LDX >= max(1,N). πŸ™ˆ
  • RCOND β€” DOUBLE PRECISION. The estimate of the reciprocal condition number of the matrix A. If RCOND is less than the machine precision (in particular, if RCOND = 0), the matrix is singular to working precision. This condition is indicated by a return code of INFO > 0. 😭
  • FERR β€” DOUBLE PRECISION array, dimension (NRHS). The estimated forward error bound for each solution vector X(j) (the j-th column of the solution matrix X). If XTRUE is the true solution corresponding to X(j), FERR(j) is an estimated upper bound for the magnitude of the largest element in (X(j) - XTRUE) divided by the magnitude of the largest element in X(j). The estimate is as reliable as the estimate for RCOND, and is almost always a slight overestimate of the true error. 🌸
  • BERR β€” DOUBLE PRECISION array, dimension (NRHS). The componentwise relative backward error of each solution vector X(j) (i.e., the smallest relative change in any element of A or B that makes X(j) an exact solution). πŸ”₯
  • WORK β€” COMPLEX*16 array, dimension (2*N). 🫢
  • RWORK β€” DOUBLE PRECISION array, dimension (N). ✨
  • INFO β€” INTEGER.
    • = 0: successful exit.
    • < 0: if INFO = -i, the i-th argument had an illegal value.
    • > 0: if INFO = i, and i is:
      • <= N: U(i,i) is exactly zero. The factorization has not been completed unless i = N, but the factor U is exactly singular, so the solution and error bounds could not be computed. RCOND = 0 is returned.
      • = N+1: U is nonsingular, but RCOND is less than machine precision, meaning that the matrix is singular to working precision. Nevertheless, the solution and error bounds are computed because there are a number of situations where the computed solution can be more accurate than the value of RCOND would suggest.

Author πŸ‘‘

  • Univ. of Tennessee
  • Univ. of California Berkeley
  • Univ. of Colorado Denver
  • NAG Ltd.

Definition at line 291 of file zgtsvx.f.

Author (Doxygen's little note) 🌸

Generated automatically by Doxygen for LAPACK from the source code.

And that's the footer vibe, bestie: LAPACK Version 3.12.0, page gtsvx(3) β€” no date listed, just pure factorization energy πŸ’…βœ¨

πŸ“¦ where this page comes from