lapacke_cgelsy_work.c(3)

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

πŸ’… lapacke_cgelsy_work.c β€” a LAPACK moment

okay so real talk, bestie: this page is from the LAPACK manual, and it's basically a lil' directory entry for one very specific C function. it's giving "backstage pass to the cgelsy machinery" and honestly? iconic. let's get into it πŸŽ€


✨ NAME ✨

lapacke_cgelsy_work.c β€” that's literally it, that's the name, no further notes, the source file speaks for itself πŸ’β€β™€οΈ


🌸 SYNOPSIS 🌸

the include you need, exactly as written (yes, with the single quotes, don't @ me, that's what the page says):

#include 'lapacke_utils.h'

πŸ¦‹ Functions πŸ¦‹

here's the one and only function this file is serving:

lapack_int LAPACKE_cgelsy_work (int matrix_layout, lapack_int m,
    lapack_int n, lapack_int nrhs, lapack_complex_float *a, lapack_int
    lda, lapack_complex_float *b, lapack_int ldb, lapack_int *jpvt,
    float rcond, lapack_int *rank, lapack_complex_float *work,
    lapack_int lwork, float *rwork)

look at all those parameters. she's thorough πŸ’…


πŸ‘‘ Function Documentation πŸ‘‘

πŸ’– `lapack_int LAPACKE_cgelsy_work (int matrix_layout, lapack_int m, lapack_int n, lapack_int nrhs, lapack_complex_float * a, lapack_int lda, lapack_complex_float * b, lapack_int ldb, lapack_int * jpvt, float rcond, lapack_int * rank, lapack_complex_float * work, lapack_int lwork, float * rwork) πŸ’–

so this is the full signature again, spelled out all pretty with the spaces and the asterisks where they belong β€” matching the SYNOPSIS above, just with the formatting a little more relaxed:

lapack_int LAPACKE_cgelsy_work (int matrix_layout, lapack_int m, lapack_int
    n, lapack_int nrhs, lapack_complex_float * a, lapack_int lda,
    lapack_complex_float * b, lapack_int ldb, lapack_int * jpvt, float
    rcond, lapack_int * rank, lapack_complex_float * work, lapack_int lwork,
    float * rwork)

and where does it live? Definition at line 36 of file lapacke_cgelsy_work.c. yes bestie, line 36, write it down πŸ“

fr fr, the page doesn't give you a description of what the function does β€” it just hands you the signature and the line number. no cap, that's the whole tea. if you need the behavior deets, that's a different page's problem πŸ™ˆ

🧚 Author 🧚

Generated automatically by Doxygen for LAPACK from the source code. so nobody hand-wrote this, the doc tool just did its lil' thing and we respect it 🫢


and that's the whole page, bestie! πŸ’œ cute lil' sign-off time: this was Version 3.8.0, dated Tue Nov 14 2017 β€” vintage LAPACK energy, we love to see it ⭐🌈✨

πŸ“¦ where this page comes from