TPRFS - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English
template<typename T>
void tprfs(char *uplo, char *trans, char *diag, integer *n, integer *nrhs, T *ap, T *b, integer *ldb, T *x, integer *ldx, T *ferr, T *berr, T *work, integer *iwork, integer *info)#

TPRFS provides error bounds and backward error estimates

for the solution to a system of linear equations.

Purpose:

  TPRFS provides error bounds and backward error estimates for the
  solution to a system of linear equations with a triangular packed
  coefficient matrix.

  The solution matrix X must be computed by STPTRS or some other
  means before entering this routine.  STPRFS does not do iterative
  refinement because doing so cannot improve the backward error.
Parameters:
  • UPLO[in]

    UPLO is CHARACTER*1

    = ‘U’: A is upper triangular;

    = ‘L’: A is lower triangular.
  • TRANS[in]

    TRANS is 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)
  • DIAG[in]

    DIAG is CHARACTER*1

    = ‘N’: A is non-unit triangular;

    = ‘U’: A is unit triangular.
  • N[in]

    N is INTEGER

    The order of the matrix A. N >= 0.

  • NRHS[in]

    NRHS is INTEGER

    The number of right hand sides, i.e., the number of columns of the matrices B and X. NRHS >= 0.

  • AP[in]

    AP is REAL array, dimension (N*(N+1)/2)

    The upper or lower triangular matrix A, packed columnwise in a linear array. The j-th column of A is stored in the array AP as follows:

    if UPLO = ‘U’, AP(i + (j-1)*j/2) = A(i,j) for 1<=i<=j;

    if UPLO = ‘L’, AP(i + (j-1)*(2*n-j)/2) = A(i,j) for j<=i<=n.

    If DIAG = ‘U’, the diagonal elements of A are not referenced and are assumed to be 1.
  • B[in]

    B is REAL array, dimension (LDB,NRHS)

    The right hand side matrix B.

  • LDB[in]

    LDB is INTEGER

    The leading dimension of the array B. LDB >= fla_max(1,N).

  • X[in]

    X is REAL array, dimension (LDX,NRHS)

    The solution matrix X.

  • LDX[in]

    LDX is INTEGER

    The leading dimension of the array X. LDX >= fla_max(1,N).

  • FERR[out]

    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[out]

    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[out] WORK is REAL array, dimension (3*N)

  • IWORK[out] IWORK is INTEGER array, dimension (N)

  • INFO[out]

    INFO is INTEGER

    = 0: successful exit

    < 0: if INFO = -i, the i-th argument had an illegal value
template<typename T, typename Ta>
void tprfs(char *uplo, char *trans, char *diag, integer *n, integer *nrhs, T *ap, T *b, integer *ldb, T *x, integer *ldx, Ta *ferr, Ta *berr, T *work, Ta *rwork, integer *info)#