CPBEQU(3)

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

πŸ’… CPBEQU(3) β€” Library Functions Manual ✨

okay bestie, this page lives at /home/abui...RC/cpbequ.f(3), and it’s here to explain the CPBEQU subroutine. No cap. πŸ’–

🌸 NAME 🌸

/home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/SRC/cpbequ.f


🫢 SYNOPSIS 🫢

Functions/Subroutines πŸ¦‹

       subroutine CPBEQU (uplo, n, kd, ab, ldab, s, scond, amax, info)
           CPBEQU

πŸ¦‹ Function/Subroutine Documentation πŸ¦‹

Here’s the full signature, bestie β€” copied exactly so nobody comes for us:

       subroutine CPBEQU (character uplo, integer n, integer kd, complex,
           dimension( ldab, * ) ab, integer ldab, real, dimension( * ) s, real
           scond, real amax, integer info)
           CPBEQU

πŸŽ€ Purpose πŸŽ€

CPBEQU computes row and column scalings intended to equilibrate a Hermitian positive definite band matrix A and reduce its condition number (with respect to the two-norm). S contains the scale factors, S(i) = 1/sqrt(A(i,i)), chosen so that the scaled matrix B with elements B(i,j) = S(i)*A(i,j)*S(j) has ones on the diagonal. This choice of S puts the condition number of B within a factor N of the smallest possible condition number over all possible diagonal scalings. slay linear algebra moment ✨

🌸 Parameters 🌸

UPLO πŸ’…

  • UPLO is CHARACTER*1.
    • = 'U': Upper triangular of A is stored;
    • = 'L': Lower triangular of A is stored.

N ⭐

  • N is INTEGER.
  • The order of the matrix A. N >= 0.

KD πŸ¦‹

  • KD is INTEGER.
  • The number of superdiagonals of the matrix A if UPLO = 'U', or the number of subdiagonals if UPLO = 'L'. KD >= 0.

AB πŸ’–

  • AB is COMPLEX array, dimension (LDAB,N).
  • The upper or lower triangle of the Hermitian band matrix A, stored in the first KD+1 rows of the array. The j-th column of A is stored in the j-th column of the array AB as follows:
if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-kd)<=i<=j;
if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for j<=i<=min(n,j+kd).

LDAB 🌈

  • LDAB is INTEGER.
  • The leading dimension of the array A. LDAB >= KD+1.

S πŸ“

  • S is REAL array, dimension (N).
  • If INFO = 0, S contains the scale factors for A.

SCOND 🧚

  • SCOND is REAL.
  • If INFO = 0, the docs say S contains the ratio of the smallest S(i) to the largest S(i). If SCOND >= 0.1 and AMAX is neither too large nor too small, it is not worth scaling by S.

AMAX πŸ’œ

  • AMAX is REAL.
  • Absolute value of largest matrix element. If AMAX is very close to overflow or very close to underflow, the matrix should be scaled.

INFO πŸ”₯

  • INFO is INTEGER.
    • = 0: successful exit.
    • < 0: if INFO = -i, the i-th argument had an illegal value.
    • > 0: if INFO = i, the i-th diagonal element is nonpositive.

🫢 Author 🫢

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

πŸ“Œ Definition at line 129 of file cpbequ.f πŸ“Œ

This lil subroutine is defined at line 129 of file cpbequ.f. periodt.

πŸŽ€ Author (generated automatically) πŸŽ€

Generated automatically by Doxygen for LAPACK from the source code.


Footer tea, bestie: LAPACK Version 3.12.0 and /home/abui...RC/cpbequ.f(3) β€” date? Not in the footer, so we’re not inventing one. πŸ’…πŸ’–

πŸ“¦ where this page comes from