gtcon(3)

okay bestie, welcome to gtcon(3) from the Library Functions Manual πŸ’… This page is all about condition number estimates, and it comes in four flavors β€” c, d, s, and z β€” because of course it does. Let’s get into it ✨

🌸 NAME 🌸

gtcon β€” gtcon: condition number estimate πŸŽ€

✨ SYNOPSIS ✨

πŸ¦‹ Functions πŸ¦‹

subroutine cgtcon (norm, n, dl, d, du, du2, ipiv, anorm, rcond, work,
    info)
    CGTCON
subroutine dgtcon (norm, n, dl, d, du, du2, ipiv, anorm, rcond, work,
    iwork, info)
    DGTCON
subroutine sgtcon (norm, n, dl, d, du, du2, ipiv, anorm, rcond, work,
    iwork, info)
    SGTCON
subroutine zgtcon (norm, n, dl, d, du, du2, ipiv, anorm, rcond, work,
    info)
    ZGTCON

🌈 Detailed Description 🌈

This part is literally just the doorway into the function docs, bestie β€” no extra side quest here πŸ’«

πŸ’– Function Documentation πŸ’–

πŸ¦‹ cgtcon / CGTCON πŸ¦‹

subroutine cgtcon (character norm, integer n, complex, dimension( * ) dl,
    complex, dimension( * ) d, complex, dimension( * ) du, complex,
    dimension( * ) du2, integer, dimension( * ) ipiv, real anorm, real
    rcond, complex, dimension( * ) work, integer info)

🎯 Purpose

CGTCON estimates the reciprocal of the condition number of a complex tridiagonal matrix A using the LU factorization as computed by CGTTRF.

An estimate is obtained for norm(inv(A)), and the reciprocal of the condition number is computed as RCOND = 1 / (ANORM * norm(inv(A))). πŸ”₯

🧸 Parameters

  • NORM β€” is CHARACTER*1. It specifies whether the 1-norm condition number or the infinity-norm condition number is required:
    • = '1' or 'O': 1-norm;
    • = 'I': Infinity-norm.
  • N β€” is INTEGER. The order of the matrix A. N >= 0.
  • DL β€” is COMPLEX array, dimension (N-1). The (n-1) multipliers that define the matrix L from the LU factorization of A as computed by CGTTRF.
  • D β€” is COMPLEX array, dimension (N). The n diagonal elements of the upper triangular matrix U from the LU factorization of A.
  • DU β€” is COMPLEX array, dimension (N-1). The (n-1) elements of the first superdiagonal of U.
  • DU2 β€” is COMPLEX array, dimension (N-2). The (n-2) elements of the second superdiagonal of U.
  • IPIV β€” is INTEGER array, dimension (N). The pivot indices; for 1 <= i <= n, 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.
  • ANORM β€” is REAL. If NORM = '1' or 'O', the 1-norm of the original matrix A. If NORM = 'I', the infinity-norm of the original matrix A.
  • RCOND β€” is REAL. The reciprocal of the condition number of the matrix A, computed as RCOND = 1/(ANORM * AINVNM), where AINVNM is an estimate of the 1-norm of inv(A) computed in this routine.
  • WORK β€” is COMPLEX array, dimension (2*N).
  • INFO β€” is INTEGER:
    • = 0: successful exit
    • < 0: if INFO = -i, the i-th argument had an illegal value

πŸ‘‘ Author

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

Definition at line 139 of file cgtcon.f. πŸ“Œ


πŸ’œ dgtcon / DGTCON πŸ’œ

subroutine dgtcon (character norm, integer n, double precision, dimension( *
    ) dl, double precision, dimension( * ) d, double precision, dimension( *
    ) du, double precision, dimension( * ) du2, integer, dimension( * )
    ipiv, double precision anorm, double precision rcond, double precision,
    dimension( * ) work, integer, dimension( * ) iwork, integer info)

🎯 Purpose

DGTCON estimates the reciprocal of the condition number of a real tridiagonal matrix A using the LU factorization as computed by DGTTRF.

An estimate is obtained for norm(inv(A)), and the reciprocal of the condition number is computed as RCOND = 1 / (ANORM * norm(inv(A))). ⭐

🧸 Parameters

  • NORM β€” is CHARACTER*1. It specifies whether the 1-norm condition number or the infinity-norm condition number is required:
    • = '1' or 'O': 1-norm;
    • = 'I': Infinity-norm.
  • N β€” is INTEGER. The order of the matrix A. N >= 0.
  • DL β€” is DOUBLE PRECISION array, dimension (N-1). The (n-1) multipliers that define the matrix L from the LU factorization of A as computed by DGTTRF.
  • D β€” is DOUBLE PRECISION array, dimension (N). The n diagonal elements of the upper triangular matrix U from the LU factorization of A.
  • DU β€” is DOUBLE PRECISION array, dimension (N-1). The (n-1) elements of the first superdiagonal of U.
  • DU2 β€” is DOUBLE PRECISION array, dimension (N-2). The (n-2) elements of the second superdiagonal of U.
  • IPIV β€” is INTEGER array, dimension (N). The pivot indices; for 1 <= i <= n, 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.
  • ANORM β€” is DOUBLE PRECISION. If NORM = '1' or 'O', the 1-norm of the original matrix A. If NORM = 'I', the infinity-norm of the original matrix A.
  • RCOND β€” is DOUBLE PRECISION. The reciprocal of the condition number of the matrix A, computed as RCOND = 1/(ANORM * AINVNM), where AINVNM is an estimate of the 1-norm of inv(A) computed in this routine.
  • WORK β€” is DOUBLE PRECISION array, dimension (2*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

πŸ‘‘ Author

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

Definition at line 144 of file dgtcon.f. πŸ“Œ


πŸŽ€ sgtcon / SGTCON πŸŽ€

subroutine sgtcon (character norm, integer n, real, dimension( * ) dl, real,
    dimension( * ) d, real, dimension( * ) du, real, dimension( * ) du2,
    integer, dimension( * ) ipiv, real anorm, real rcond, real, dimension( *
    ) work, integer, dimension( * ) iwork, integer info)

🎯 Purpose

SGTCON estimates the reciprocal of the condition number of a real tridiagonal matrix A using the LU factorization as computed by SGTTRF.

An estimate is obtained for norm(inv(A)), and the reciprocal of the condition number is computed as RCOND = 1 / (ANORM * norm(inv(A))). πŸ’–

🧸 Parameters

  • NORM β€” is CHARACTER*1. It specifies whether the 1-norm condition number or the infinity-norm condition number is required:
    • = '1' or 'O': 1-norm;
    • = 'I': Infinity-norm.
  • N β€” is INTEGER. The order of the matrix A. N >= 0.
  • DL β€” is REAL array, dimension (N-1). The (n-1) multipliers that define the matrix L from the LU factorization of A as computed by SGTTRF.
  • D β€” is REAL array, dimension (N). The n diagonal elements of the upper triangular matrix U from the LU factorization of A.
  • DU β€” is REAL array, dimension (N-1). The (n-1) elements of the first superdiagonal of U.
  • DU2 β€” is REAL array, dimension (N-2). The (n-2) elements of the second superdiagonal of U.
  • IPIV β€” is INTEGER array, dimension (N). The pivot indices; for 1 <= i <= n, 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.
  • ANORM β€” is REAL. If NORM = '1' or 'O', the 1-norm of the original matrix A. If NORM = 'I', the infinity-norm of the original matrix A.
  • RCOND β€” is REAL. The reciprocal of the condition number of the matrix A, computed as RCOND = 1/(ANORM * AINVNM), where AINVNM is an estimate of the 1-norm of inv(A) computed in this routine.
  • WORK β€” is REAL array, dimension (2*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

πŸ‘‘ Author

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

Definition at line 144 of file sgtcon.f. πŸ“Œ


πŸ¦‹ zgtcon / ZGTCON πŸ¦‹

subroutine zgtcon (character norm, integer n, complex*16, dimension( * ) dl,
    complex*16, dimension( * ) d, complex*16, dimension( * ) du, complex*16,
    dimension( * ) du2, integer, dimension( * ) ipiv, double precision
    anorm, double precision rcond, complex*16, dimension( * ) work, integer
    info)

🎯 Purpose

ZGTCON estimates the reciprocal of the condition number of a complex tridiagonal matrix A using the LU factorization as computed by ZGTTRF.

An estimate is obtained for norm(inv(A)), and the reciprocal of the condition number is computed as RCOND = 1 / (ANORM * norm(inv(A))). 🌟

🧸 Parameters

  • NORM β€” part 2 picks up right here, bestie; this is where part 1 ends 🫢
  • NORM is CHARACTER*1 β€” tells us which condition-number flavor we're serving: the 1-norm condition number or the infinity-norm condition number. The recipe:
    • '1' or 'O': 1-norm;
    • 'I': infinity-norm.
  • N is INTEGER β€” the order of matrix A. N >= 0, bestie, no negative-order nonsense.
  • DL is COMPLEX*16 array, dimension (N-1) β€” the (n-1) multipliers that define the matrix L from the LU factorization of A as computed by ZGTTRF. Slay, that's the lower-triangular tea.
  • D is COMPLEX*16 array, dimension (N) β€” the n diagonal elements of the upper triangular matrix U from the LU factorization of A.
  • DU is COMPLEX*16 array, dimension (N-1) β€” the (n-1) elements of the first superdiagonal of U.
  • DU2 is COMPLEX*16 array, dimension (N-2) β€” the (n-2) elements of the second superdiagonal of U.
  • IPIV is INTEGER array, dimension (N) β€” the pivot indices; for 1 <= i <= n, 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. No cap, that's the whole pivot story.
  • ANORM is DOUBLE PRECISION β€” if NORM = '1' or 'O', this is the 1-norm of the original matrix A. If NORM = 'I', it's the infinity-norm of the original matrix A.
  • RCOND is DOUBLE PRECISION β€” the reciprocal of the condition number of matrix A, computed as RCOND = 1/(ANORM * AINVNM), where AINVNM is an estimate of the 1-norm of inv(A) computed in this routine.
  • WORK is COMPLEX*16 array, dimension (2*N) β€” workspace, doing its lil behind-the-scenes thing. ✨
  • INFO is INTEGER β€” the vibe check:
    • = 0: successful exit πŸŽ‰
    • < 0: if INFO = -i, the i-th argument had an illegal value πŸ™ˆ

πŸ‘‘ Author

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

Definition at line 139 of file zgtcon.f.

πŸŽ€ Author

Generated automatically by Doxygen for LAPACK from the source code.

πŸ’– Okay bestie, that's the whole page: source LAPACK, version 3.12.0, page gtcon(3), and the footer didn't hand us a date so we're simply timeless. Bye bestie! πŸ’…
πŸ“¦ where this page comes from