lapacke_zggsvp3.c(3)

πŸ“¦ version 3.9.0, in centos-stream 9

πŸ’… lapacke_zggsvp3.c β€” the manual page, but make it make sense

okay so bestie, before we even start: the manual name is lapacke_zggsvp3.c, and this whole page is LAPACK's auto-generated docs for exactly one function. that's it. that's the whole vibe. it's giving "reference card, not a tutorial" and honestly? iconic.


✨ NAME ✨

lapacke_zggsvp3.c β€” no cap, the name is just the filename. the C file is the moment. πŸŽ€


🌸 SYNOPSIS 🌸

first things first, you gotta pull in the header:

#include 'lapacke_utils.h'

(yes, with the single quotes exactly like that β€” I'm not touching it, that's what the page says, periodt.)

πŸ¦‹ Functions πŸ¦‹

one single function lives here, and she's a long one, so let me lay her out with full main-character energy:

lapack_int LAPACKE_zggsvp3 (int matrix_layout, char jobu, char jobv,
    char jobq, lapack_int m, lapack_int p, lapack_int n,
    lapack_complex_double *a, lapack_int lda, lapack_complex_double *b,
    lapack_int ldb, double tola, double tolb, lapack_int *k, lapack_int
    *l, lapack_complex_double *u, lapack_int ldu, lapack_complex_double
    *v, lapack_int ldv, lapack_complex_double *q, lapack_int ldq)

that's twenty whole arguments, bestie. twenty. she's high-maintenance and we respect her for it. πŸ’€


πŸ‘‘ Function Documentation πŸ‘‘

πŸ’– lapack_int LAPACKE_zggsvp3 (...)

here she is again, spelled out in full, same signature, same everything β€” I'm not summarising, I'm not merging, I'm not "cleaning it up" because that's how you break a build and we do not break builds in this house:

lapack_int LAPACKE_zggsvp3 (int matrix_layout, char jobu, char jobv, char
    jobq, lapack_int m, lapack_int p, lapack_int n, lapack_complex_double *
    a, lapack_int lda, lapack_complex_double * b, lapack_int ldb, double
    tola, double tolb, lapack_int * k, lapack_int * l, lapack_complex_double
    * u, lapack_int ldu, lapack_complex_double * v, lapack_int ldv,
    lapack_complex_double * q, lapack_int ldq)

so what are all these cuties? quickly, in order, zero guessing on my part β€” the page gives us the types and the names and that's literally it:

  • int matrix_layout β€” an int. it's the layout flag, first in line, doing her thing.
  • char jobu β€” a char named jobu.
  • char jobv β€” a char named jobv.
  • char jobq β€” a char named jobq.
  • lapack_int m β€” a lapack_int, obvs.
  • lapack_int p β€” another one.
  • lapack_int n β€” and the third of the trio.
  • lapack_complex_double *a β€” pointer to your a, with lapack_int lda riding shotgun.
  • lapack_complex_double *b β€” pointer to your b, with lapack_int ldb right behind.
  • double tola β€” a plain double, named tola.
  • double tolb β€” a plain double, named tolb.
  • lapack_int *k β€” a pointer, so something's getting written back here πŸ‘€.
  • lapack_int *l β€” same deal, pointer queen.
  • lapack_complex_double *u β€” pointer to u, plus lapack_int ldu.
  • lapack_complex_double *v β€” pointer to v, plus lapack_int ldv.
  • lapack_complex_double *q β€” pointer to q, plus lapack_int ldq.
real talk: this manpage does not document what any of these actually do β€” no descriptions of jobu/jobv/jobq values, no meaning for tola/tolb, no output semantics for k and l. I refuse to invent lore. go read the real LAPACK docs for zggsvp3 before you call it, fr fr. πŸ™ˆ

and the receipts: Definition at line 36 of file lapacke_zggsvp3.c. that's where she lives. πŸ’…


🧚 Author 🧚

it was generated automatically by Doxygen for LAPACK from the source code. not hand-written by a person, not vibes-based β€” robot-generated from the actual source. so if something here looks terse, that's the Doxygen aesthetic, not a personal attack. πŸ’œ


🌈 a lil sign-off 🌈

this page is tagged Version 3.8.0, dated Tue Nov 14 2017, and it's the lapacke_zggsvp3.c manpage from the LAPACK set. go forth, pass all twenty arguments, and remember: twenty arguments is not a red flag, it's just her season. slay πŸ«Άβœ¨πŸ“

πŸ“¦ where this page comes from