lantp(3)

🌸 NAME 🌸

lantp β€” lantp: triangular matrix, packed

bestie. welcome to the lantp page πŸ’… this is a Library Functions Manual situation, and it's literally four almost-identical functions who all showed up in the same outfit. no cap, they're the norm-getters for triangular matrices in packed form, and they are lowkey iconic. let's get into it 🫢


✨ SYNOPSIS ✨

πŸ’œ Functions

  • real function clantp (norm, uplo, diag, n, ap, work) β€” CLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.
  • double precision function dlantp (norm, uplo, diag, n, ap, work) β€” DLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.
  • real function slantp (norm, uplo, diag, n, ap, work) β€” SLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.
  • double precision function zlantp (norm, uplo, diag, n, ap, work) β€” ZLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.

πŸ¦‹ Detailed Description πŸ¦‹

okay so this page is literally just the function documentation section. no lore, no backstory, just the four besties below. πŸŽ€

πŸ‘‘ Function Documentation πŸ‘‘

πŸ’– real function clantp (character norm, character uplo, character diag, integer n, complex, dimension( * ) ap, real, dimension( * ) work)

real function clantp (character norm, character uplo, character diag,
    integer n, complex, dimension( * ) ap, real, dimension( * ) work)

CLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.

🌟 Purpose:

CLANTP returns the value of the one norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix A, supplied in packed form.

🌟 Returns

CLANTP

    CLANTP = ( max(abs(A(i,j))), NORM = 'M' or 'm'
             (
             ( norm1(A),         NORM = '1', 'O' or 'o'
             (
             ( normI(A),         NORM = 'I' or 'i'
             (
             ( normF(A),         NORM = 'F', 'f', 'E' or 'e'

where norm1 denotes the one norm of a matrix (maximum column sum), normI denotes the infinity norm of a matrix (maximum row sum) and normF denotes the Frobenius norm of a matrix (square root of sum of squares). Note that max(abs(A(i,j))) is not a consistent matrix norm. πŸ’€ like she said what she said but the math says it's not consistent, we don't make the rules.

⭐ Parameters

  • NORM β€” NORM is CHARACTER*1. Specifies the value to be returned in CLANTP as described above. πŸ‘†
  • UPLO β€” UPLO is CHARACTER*1. Specifies whether the matrix A is upper or lower triangular.
    • = 'U': Upper triangular
    • = 'L': Lower triangular
  • DIAG β€” DIAG is CHARACTER*1. Specifies whether or not the matrix A is unit triangular.
    • = 'N': Non-unit triangular
    • = 'U': Unit triangular
  • N β€” N is INTEGER. The order of the matrix A. N >= 0. When N = 0, CLANTP is set to zero. (she's giving empty and unbothered ✨)
  • AP β€” AP is COMPLEX 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)*(2n-j)/2) = A(i,j) for j<=i<=n.

Note that when DIAG = 'U', the elements of the array AP corresponding to the diagonal elements of the matrix A are not referenced, but are assumed to be one. πŸ™ˆ she's not reading those, she's just assuming bestie.

  • WORK β€” WORK is REAL array, dimension (MAX(1,LWORK)), where LWORK >= N when NORM = 'I'; otherwise, WORK is not referenced.

⭐ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

Definition at line 124 of file clantp.f.


πŸ’– double precision function dlantp (character norm, character uplo, character diag, integer n, double precision, dimension( * ) ap, double precision, dimension( * ) work)

double precision function dlantp (character norm, character uplo, character
    diag, integer n, double precision, dimension( * ) ap, double precision,
    dimension( * ) work)

DLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.

🌟 Purpose:

DLANTP returns the value of the one norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix A, supplied in packed form.

🌟 Returns

DLANTP

    DLANTP = ( max(abs(A(i,j))), NORM = 'M' or 'm'
             (
             ( norm1(A),         NORM = '1', 'O' or 'o'
             (
             ( normI(A),         NORM = 'I' or 'i'
             (
             ( normF(A),         NORM = 'F', 'f', 'E' or 'e'

where norm1 denotes the one norm of a matrix (maximum column sum), normI denotes the infinity norm of a matrix (maximum row sum) and normF denotes the Frobenius norm of a matrix (square root of sum of squares). Note that max(abs(A(i,j))) is not a consistent matrix norm. same disclaimer, different double precision queen πŸ‘‘

⭐ Parameters

  • NORM β€” NORM is CHARACTER*1. Specifies the value to be returned in DLANTP as described above.
  • UPLO β€” UPLO is CHARACTER*1. Specifies whether the matrix A is upper or lower triangular.
    • = 'U': Upper triangular
    • = 'L': Lower triangular
  • DIAG β€” DIAG is CHARACTER*1. Specifies whether or not the matrix A is unit triangular.
    • = 'N': Non-unit triangular
    • = 'U': Unit triangular
  • N β€” N is INTEGER. The order of the matrix A. N >= 0. When N = 0, DLANTP is set to zero.
  • AP β€” AP is DOUBLE PRECISION 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)*(2n-j)/2) = A(i,j) for j<=i<=n.

Note that when DIAG = 'U', the elements of the array AP corresponding to the diagonal elements of the matrix A are not referenced, but are assumed to be one.

  • WORK β€” WORK is DOUBLE PRECISION array, dimension (MAX(1,LWORK)), where LWORK >= N when NORM = 'I'; otherwise, WORK is not referenced.

⭐ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

Definition at line 123 of file dlantp.f.


πŸ’– real function slantp (character norm, character uplo, character diag, integer n, real, dimension( * ) ap, real, dimension( * ) work)

real function slantp (character norm, character uplo, character diag,
    integer n, real, dimension( * ) ap, real, dimension( * ) work)

SLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.

🌟 Purpose:

SLANTP returns the value of the one norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix A, supplied in packed form.

🌟 Returns

SLANTP

    SLANTP = ( max(abs(A(i,j))), NORM = 'M' or 'm'
             (
             ( norm1(A),         NORM = '1', 'O' or 'o'
             (
             ( normI(A),         NORM = 'I' or 'i'
             (
             ( normF(A),         NORM = 'F', 'f', 'E' or 'e'

where norm1 denotes the one norm of a matrix (maximum column sum), normI denotes the infinity norm of a matrix (maximum row sum) and normF denotes the Frobenius norm of a matrix (square root of sum of squares). Note that max(abs(A(i,j))) is not a consistent matrix norm. (yes bestie, still not consistent, we've been over this πŸ’€)

⭐ Parameters

  • NORM β€” NORM is CHARACTER*1. Specifies the value to be returned in SLANTP as described above.
  • UPLO β€” UPLO is CHARACTER*1. Specifies whether the matrix A is upper or lower triangular.
    • = 'U': Upper triangular
    • = 'L': Lower triangular
  • DIAG β€” DIAG is CHARACTER*1. Specifies whether or not the matrix A is unit triangular.
    • = 'N': Non-unit triangular
    • = 'U': Unit triangular
  • N β€” N is INTEGER. The order of the matrix A. N >= 0. When N = 0, SLANTP is set to zero.
  • AP β€” 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)*(2n-j)/2) = A(i,j) for j<=i<=n.

Note that when DIAG = 'U', the elements of the array AP corresponding to the diagonal elements of the matrix A are not referenced, but are assumed to be one.

  • WORK β€” WORK is REAL array, dimension (MAX(1,LWORK)), where LWORK >= N when NORM = 'I'; otherwise, WORK is not referenced.

⭐ Author

Univ. of Tennessee

Univ. of California Berkeley

Univ. of Colorado Denver

NAG Ltd.

Definition at line 123 of file slantp.f.


πŸ’– double precision function zlantp (character norm, character uplo, character diag, integer n, complex*16, dimension( * ) ap, double precision, dimension( * ) work)

double precision function zlantp (character norm, character uplo, character
    diag, integer n, complex*16, dimension( * ) ap, double precision,
    dimension( * ) work)

ZLANTP returns the value of the 1-norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a triangular matrix supplied in packed form.

🌟 Purpose:

…and this is exactly where part 1 hands the aux mic over to part 2 🎀✨ zlantp's purpose section picks up right here, bestie β€” don't go anywhere πŸ’œ

  • WORK β€” WORK is DOUBLE PRECISION array, dimension (MAX(1,LWORK)), where LWORK >= N when NORM = 'I'; otherwise, WORK is not referenced. πŸ’… Like, it literally only gets invited to the party when you're doing the infinity norm β€” any other time it's just standing outside, unreferenced. 🫢

🌸 Author 🌸

Okay so this function was brought to you by the absolute icons at:

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

🏫 Four institutions, one legendary collab. Main character energy fr fr. πŸ‘‘

πŸŽ€ Definition at line 124 of file zlantp.f. πŸŽ€

Yep, that's the exact spot β€” zlantp.f, line 124. If you ever need to find it, that's your map. πŸ—ΊοΈβœ¨

πŸ’œ Author (of this doc, bestie) πŸ’œ

Generated automatically by Doxygen for LAPACK from the source code.

Not me getting a whole credit line just for existing 😭 β€” the docs literally wrote themselves, iykyk. πŸ™ˆ


And that's a wrap on lantp(3)! πŸ’– Go forth and norm your triangular packed matrices responsibly. πŸ¦‹

This iconic little page comes from LAPACK, Version 3.12.0, dated lantp(3) β€” slay, documented, periodt. βœ¨πŸ‘‘

πŸ“¦ where this page comes from