ZLSETS(3)

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

πŸ¦‹ ZLSETS(3) β€” bestie, let's talk linear equality constrained least squares πŸ’…

okay so real talk: this is the zlsets.f(3) page, straight out of the LAPACK Library Functions Manual, and it lives at that path you see above. It's a Fortran thing. It's a testing thing. It's giving "I run the vibes check on ZGGLSE" and honestly? iconic. ✨


🌸 NAME 🌸

/home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/TESTING/EIG/zlsets.f

like, that's the whole name. the file. that's it. she's a whole path and she owns it πŸŽ€


🫢 SYNOPSIS 🫢

Functions/Subroutines

  • subroutine ZLSETS (m, p, n, a, af, lda, b, bf, ldb, c, cf, d, df, x, work, lwork, rwork, result) β€” the one and only ZLSETS, no cap
subroutine ZLSETS (m, p, n, a, af, lda, b, bf, ldb, c, cf, d, df, x,
    work, lwork, rwork, result)
    ZLSETS

πŸ‘‘ Function/Subroutine Documentation πŸ‘‘

πŸ’œ subroutine ZLSETS

here's the full glow-up of the signature, literally every argument in her full fit:

subroutine ZLSETS (integer m, integer p, integer n, complex*16, dimension(
    lda, * ) a, complex*16, dimension( lda, * ) af, integer lda, complex*16,
    dimension( ldb, * ) b, complex*16, dimension( ldb, * ) bf, integer ldb,
    complex*16, dimension( * ) c, complex*16, dimension( * ) cf, complex*16,
    dimension( * ) d, complex*16, dimension( * ) df, complex*16, dimension(
    * ) x, complex*16, dimension( lwork ) work, integer lwork, double
    precision, dimension( * ) rwork, double precision, dimension( 2 )
    result)
    ZLSETS

✨ Purpose ✨

!> !> ZLSETS tests ZGGLSE - a subroutine for solving linear equality !> constrained least square problem (LSE). !>

so she's a tester. she tests ZGGLSE, which is the subroutine that solves the linear equality constrained least square problem, aka LSE. she's the friend who double-checks your outfit before you leave the house. we stan a supportive queen πŸ”₯


πŸŽ€ Parameters πŸŽ€

okay bestie, buckle up, here comes the whole cast:

  • M πŸ’–

!> M is INTEGER !> The number of rows of the matrix A. M >= 0. !>

the row count of A. and she's gotta be M >= 0.

  • P πŸ’–

!> P is INTEGER !> The number of rows of the matrix B. P >= 0. !>

the row count of B. P >= 0, always.

  • N πŸ’–

!> N is INTEGER !> The number of columns of the matrices A and B. N >= 0. !>

the column count for both A and B. N >= 0. shared custody, love that for them.

  • A πŸ’–

!> A is COMPLEX*16 array, dimension (LDA,N) !> The M-by-N matrix A. !>

the M-by-N matrix A, in all her COMPLEX*16 glory.

  • AF πŸ’–

!> AF is COMPLEX*16 array, dimension (LDA,N) !>

type COMPLEX*16, dimension (LDA,N). that's the whole note. no further comment, she said what she said πŸ™ˆ

  • LDA πŸ’–

!> LDA is INTEGER !> The leading dimension of the arrays A, AF, Q and R. !> LDA >= max(M,N). !>

the leading dimension of A, AF, Q and R. she must clear LDA >= max(M,N).

  • B πŸ’–

!> B is COMPLEX*16 array, dimension (LDB,N) !> The P-by-N matrix A. !>

type COMPLEX*16, dimension (LDB,N). and yep, the source literally says "The P-by-N matrix A." β€” that's what it says, we're not editing it, it's part of the lore 😭

  • BF πŸ’–

!> BF is COMPLEX*16 array, dimension (LDB,N) !>

again, that's the description. COMPLEX*16, dimension (LDB,N), mic drop 🎀

  • LDB πŸ’–

!> LDB is INTEGER !> The leading dimension of the arrays B, BF, V and S. !> LDB >= max(P,N). !>

the leading dimension of B, BF, V and S. she must clear LDB >= max(P,N).

  • C πŸ’–

!> C is COMPLEX*16 array, dimension( M ) !> the vector C in the LSE problem. !>

the vector C in the LSE problem. main character of the equality constraint, periodt.

  • CF πŸ’–

!> CF is COMPLEX*16 array, dimension( M ) !>

COMPLEX*16, dimension (M). that's the descriptor, bestie.

  • D πŸ’–

!> D is COMPLEX*16 array, dimension( P ) !> the vector D in the LSE problem. !>

the vector D in the LSE problem. her moment.

  • DF πŸ’–

!> DF is COMPLEX*16 array, dimension( P ) !>

COMPLEX*16, dimension (P). short and sweet.

  • X πŸ’–

!> X is COMPLEX*16 array, dimension( N ) !> solution vector X in the LSE problem. !>

the solution vector X in the LSE problem. THE answer. the one we were all waiting for 🌟

  • WORK πŸ’–

!> WORK is COMPLEX*16 array, dimension (LWORK) !>

COMPLEX*16, dimension (LWORK). workspace, doing the invisible labour, respect.

  • LWORK πŸ’–

!> LWORK is INTEGER !> The dimension of the array WORK. !>

the dimension of WORK. that's the whole vibe.

  • RWORK πŸ’–

!> RWORK is DOUBLE PRECISION array, dimension (M) !>

DOUBLE PRECISION, dimension (M). yes, double precision. she's fancy.

  • RESULT πŸ’–

!> RESULT is DOUBLE PRECISION array, dimension (2) !> The test ratios: !> RESULT(1) = norm( A*x - c )/ norm(A)*norm(X)*EPS !> RESULT(2) = norm( B*x - d )/ norm(B)*norm(X)*EPS !>

DOUBLE PRECISION, dimension (2), and she carries the test ratios:

RESULT(1) = norm( A*x - c )/ norm(A)*norm(X)*EPS
RESULT(2) = norm( B*x - d )/ norm(B)*norm(X)*EPS

two ratios. two vibes. one RESULT array. slay πŸ’…


🌈 Author 🌈

the whole squad gets credit, fr fr:

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

Definition at line 149 of file zlsets.f.


⭐ Author ⭐

Generated automatically by Doxygen for LAPACK from the source code.


okay that's the page!! πŸ¦‹ thanks for reading all the way to the end, you're a real one 🫢 this was LAPACK Version 3.12.0, and yeah β€” a robot named Doxygen wrote the sign-off, but the hype is 100% genuine πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from