DPOT02(3)

πŸ“¦ version 3.12.0, in opensuse-leap 16.0

okay bestie, welcome to the dpot02.f(3) page from the Library Functions Manual β€” LAPACK routine realness, but make it cute. πŸ’…βœ¨

NAME πŸŽ€

the whole name situation is literally this source file path:

/home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/TESTING/LIN/dpot02.f

no extra nickname, no secret identity. it’s giving β€œmy name is my path” energy. 🫢

SYNOPSIS πŸ¦‹

Functions/Subroutines

subroutine DPOT02 (uplo, n, nrhs, a, lda, x, ldx, b, ldb, rwork, resid)
           DPOT02

Function/Subroutine Documentation πŸ”₯

here’s the full signature, copied exactly because we do not mess with function signatures in this house:

subroutine DPOT02 (character uplo, integer n, integer nrhs, double
    precision, dimension( lda, * ) a, integer lda, double precision,
    dimension( ldx, * ) x, integer ldx, double precision, dimension( ldb, *
    ) b, integer ldb, double precision, dimension( * ) rwork, double
    precision resid)
       DPOT02

and yes, DPOT02 appears again on its own line. iconic. πŸ‘‘

Purpose 🎯

!>
!> DPOT02 computes the residual for the solution of a symmetric system
!> of linear equations  A*x = b:
!>
!>    RESID = norm(B - A*X) / ( norm(A) * norm(X) * EPS ),
!>
!> where EPS is the machine epsilon.
!>

so basically DPOT02 computes the residual for the solution of a symmetric system of linear equations A*x = b, and the residual formula is right there: RESID = norm(B - A*X) / ( norm(A) * norm(X) * EPS ), where EPS is the machine epsilon. no cap, that’s the whole purpose. πŸ’–

Parameters 🌸

every parameter, every type, every constraint β€” no skipping, bestie:

  • UPLO β€” CHARACTER*1. Specifies whether the upper or lower triangular part of the symmetric matrix A is stored: = 'U': Upper triangular, = 'L': Lower triangular. choose your triangle, bestie. πŸ’…
  • N β€” INTEGER. The number of rows and columns of the matrix A. N >= 0.
  • NRHS β€” INTEGER. The number of columns of B, the matrix of right hand sides. NRHS >= 0.
  • A β€” DOUBLE PRECISION array, dimension (LDA,N). The original symmetric matrix A.
  • LDA β€” INTEGER. The leading dimension of the array A. LDA >= max(1,N)
  • X β€” DOUBLE PRECISION array, dimension (LDX,NRHS). The computed solution vectors for the system of linear equations.
  • LDX β€” INTEGER. The leading dimension of the array X. LDX >= max(1,N).
  • B β€” DOUBLE PRECISION array, dimension (LDB,NRHS). On entry, the right hand side vectors for the system of linear equations. On exit, B is overwritten with the difference B - A*X. this is important: it gets changed, so don’t act surprised. 😭
  • LDB β€” INTEGER. The leading dimension of the array B. LDB >= max(1,N)
  • RWORK β€” DOUBLE PRECISION array, dimension (N).
  • RESID β€” DOUBLE PRECISION. The maximum over the number of right hand sides of norm(B - A*X) / ( norm(A) * norm(X) * EPS ).

Author πŸ‘‘

the author lineup, exactly as listed:

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

Definition at line 125 of file dpot02.f.

Author 🫢

and the Doxygen-generated author note says: Generated automatically by Doxygen for LAPACK from the source code. periodt.


shoutout to LAPACK Version 3.12.0, the source path /home/abui...IN/dpot02.f(3), and the date β€” which this footer literally didn’t print, so we’re calling it a mystery date πŸ•΅οΈβ€β™€οΈπŸ’–

πŸ“¦ where this page comes from