CCKGSV(3)

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

πŸ’… CCKGSV(3) β€” the cckgsv.f page, section 3 of the manual, bestie ✨

okay so real quick: this is a manual page from section 3 (that's the library-functions girlies πŸŽ€), and the file it lives in is, like, deeply nested β€” no cap, look at this path:

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

that's the NAME section btw. she's a whole address πŸ’€


🌈 SYNOPSIS 🌈

🌸 Functions/Subroutines 🌸

  • subroutine CCKGSV (nm, mval, pval, nval, nmats, iseed, thresh, nmax, a, af, b, bf, u, v, q, alpha, beta, r, iwork, work, rwork, nin, nout, info) β€” CCKGSV ✨ (yes that's the whole description the original gave us and honestly? iconic minimalism πŸ’…)

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

here's the full signature, and yes every single argument is listed, we are NOT skipping anybody, everyone's invited to the party 🫢

subroutine CCKGSV (integer nm, integer, dimension( * ) mval, integer,
    dimension( * ) pval, integer, dimension( * ) nval, integer nmats,
    integer, dimension( 4 ) iseed, real thresh, integer nmax, complex,
    dimension( * ) a, complex, dimension( * ) af, complex, dimension( * ) b,
    complex, dimension( * ) bf, complex, dimension( * ) u, complex,
    dimension( * ) v, complex, dimension( * ) q, real, dimension( * ) alpha,
    real, dimension( * ) beta, complex, dimension( * ) r, integer,
    dimension( * ) iwork, complex, dimension( * ) work, real, dimension( * )
    rwork, integer nin, integer nout, integer info)

CCKGSV πŸ’–


πŸ‘‘ Purpose: πŸ‘‘

\ CCKGSV tests CGGSVD:\ the GSVD for M-by-N matrix A and P-by-N matrix B.\

like, she's a tester. her whole job is putting CGGSVD through its paces with an M-by-N matrix A and a P-by-N matrix B. main character energy fr fr πŸ”₯


✨ Parameters ✨

πŸ“ NM

NM is INTEGER\ The number of values of M contained in the vector MVAL.

so NM is just, like, how many M's we're bringing to the function. count 'em πŸ’…

πŸ“ MVAL

MVAL is INTEGER array, dimension (NM)\ The values of the matrix row dimension M.

the actual M values themselves, bestie. row dimension of the matrix, one per slot 🌸

πŸ“ PVAL

PVAL is INTEGER array, dimension (NP)\ The values of the matrix row dimension P.

the P values β€” also row dimension, but for the other matrix. note the dimension says NP, that's what the page says, we don't editorialize πŸ™ˆ

πŸ“ NVAL

NVAL is INTEGER array, dimension (NN)\ The values of the matrix column dimension N.

the N values! column dimension this time, she's different πŸ’œ

πŸ“ NMATS

NMATS is INTEGER\ The number of matrix types to be tested for each combination\ of matrix dimensions. If NMATS >= NTYPES (the maximum\ number of matrix types), then all the different types are\ generated for testing. If NMATS < NTYPES, another input line\ is read to get the numbers of the matrix types to be used.

OK so this one's got lore 🧚 β€” if NMATS >= NTYPES (that's the max number of matrix types) then every type gets generated for testing, slay. but if NMATS < NTYPES, she reads another input line to get the numbers of the matrix types to be used. dramatic much? πŸ’€

πŸ“ ISEED

ISEED is INTEGER array, dimension (4)\ On entry, the seed of the random number generator. The array\ elements should be between 0 and 4095, otherwise they will be\ reduced mod 4096, and ISEED(4) must be odd.\ On exit, the next seed in the random number sequence after\ all the test matrices have been generated.

the ✨randomness✨ seed. on entry: the seed of the RNG. rules, bestie, rules:

  • elements should be between 0 and 4095 β€” otherwise they get reduced mod 4096
  • ISEED(4) must be odd

on exit? she gives you the next seed in the random number sequence after all the test matrices have been generated. a little gift 🎁

πŸ“ THRESH

THRESH is REAL\ The threshold value for the test ratios. A result is\ included in the output file if RESULT >= THRESH. To have\ every test ratio printed, use THRESH = 0.

the vibe check πŸ’… a result makes it into the output file only if RESULT >= THRESH. want every test ratio printed? set THRESH = 0. no filter, full transparency πŸ”₯

πŸ“ NMAX

NMAX is INTEGER\ The maximum value permitted for M or N, used in dimensioning\ the work arrays.

the ceiling for M or N, and she's literally the reason the work arrays are sized the way they are. structural queen πŸ‘‘

πŸ“ A

A is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ AF

AF is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ B

B is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ BF

BF is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ U

U is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ V

V is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ Q

Q is COMPLEX array, dimension (NMAX*NMAX)

seven COMPLEX girls, all dimension NMAX*NMAX, all absolutely holding it down 🫢

πŸ“ ALPHA

ALPHA is REAL array, dimension (NMAX)

(real one! different dimension! she's NMAX not NMAX*NMAX, respect the range 🌈)

πŸ“ BETA

BETA is REAL array, dimension (NMAX)

πŸ“ R

R is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ IWORK

IWORK is INTEGER array, dimension (NMAX)

πŸ“ WORK

WORK is COMPLEX array, dimension (NMAX*NMAX)

πŸ“ RWORK

RWORK is REAL array, dimension (NMAX)

πŸ“ NIN

NIN is INTEGER\ The unit number for input.

where she reads from πŸ“₯

πŸ“ NOUT

NOUT is INTEGER\ The unit number for output.

where she writes to πŸ“€ (the girlies who read the output file from THRESH, this is your address)

πŸ“ INFO

INFO is INTEGER\ = 0 : successful exit\ > 0 : If CLATMS returns an error code, the absolute value\ of it is returned.

the exit-status tea β˜•

  • = 0 β†’ successful exit, we love a clean win πŸ’–
  • > 0 β†’ if CLATMS returns an error code, the absolute value of it is returned (so, like, mask on, but the number's still feral πŸ’€)

🧚 Author 🧚

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

(the whole squad showed up, we stan a collab 🌈)


⭐ Definition at line 195 of file cckgsv.f. ⭐


πŸŽ€ Author πŸŽ€

Generated automatically by Doxygen for LAPACK from the source code.

not me being auto-generated by Doxygen 😭 she's self-aware


and that's the whole page, bestie β€” literally every flag, dimension, default and warning is up there, none skipped, periodt πŸ’…βœ¨

sign-off: this little beauty is LAPACK, Version 3.12.0, and she was living at /home/abui...IG/cckgsv.f(3) when we met her. take care of her πŸ«ΆπŸ¦‹
πŸ“¦ where this page comes from