/home/abui...ksy_rook.f(3)

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

πŸ’… /home/abui...ksy_rook.f(3) β€” Library Functions Manual πŸŽ€

okay so bestie, welcome to the LAPACK testing zone ✨ this one is a <pink>Library Functions Manual</pink> page and honestly it's giving "the most thorough test suite you've ever met" πŸ’– no cap, this file is a whole vibe check for symmetric rook-pivoting routines.


🌸 NAME 🌸

/home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/TESTING/LIN/schksy_rook.f

yep that's the whole name, it's a path, it's long, it's iconic, we love her 🫢 literally the full filesystem glow-up of a test file.


✨ SYNOPSIS ✨

πŸ¦‹ Functions/Subroutines

  • subroutine SCHKSY_ROOK β€” (dotype, nn, nval, nnb, nbval, nns, nsval, thresh, tsterr, nmax, a, afac, ainv, b, x, xact, work, rwork, iwork, nout)

lowkey the whole crew is here, SCHKSY_ROOK is the main character πŸ‘‘

subroutine SCHKSY_ROOK (dotype, nn, nval, nnb, nbval, nns, nsval,
    thresh, tsterr, nmax, a, afac, ainv, b, x, xact, work, rwork, iwork,
    nout)

πŸ’œ Function/Subroutine Documentation πŸ’œ

🌈 subroutine SCHKSY_ROOK

here's the full signature with all the type tea β˜• every argument spelled out exactly, don't come for me:

subroutine SCHKSY_ROOK (logical, dimension( * ) dotype, integer nn, integer,
    dimension( * ) nval, integer nnb, integer, dimension( * ) nbval, integer
    nns, integer, dimension( * ) nsval, real thresh, logical tsterr, integer
    nmax, real, dimension( * ) a, real, dimension( * ) afac, real,
    dimension( * ) ainv, real, dimension( * ) b, real, dimension( * ) x,
    real, dimension( * ) xact, real, dimension( * ) work, real, dimension( *
    ) rwork, integer, dimension( * ) iwork, integer nout)

SCHKSY_ROOK 🌟


πŸŽ€ Purpose:

!> !> SCHKSY_ROOK tests SSYTRF_ROOK, -TRI_ROOK, -TRS_ROOK, !> and -CON_ROOK. !>

so yeah bestie, she tests four whole routines: SSYTRF_ROOK, -TRI_ROOK, -TRS_ROOK and -CON_ROOK πŸ’€ that's the entire rook-pivot family getting a full inspection. obsessed.


🧚 Parameters 🧚

okay this is the long part, grab a strawberry πŸ“, we're going through every single one:

  • DOTYPE β€” !> DOTYPE is LOGICAL array, dimension (NTYPES) β€” !> The matrix types to be used for testing. Matrices of type j β€” !> (for 1 <= j <= NTYPES) are used for testing if DOTYPE(j) = β€” !> .TRUE.; if DOTYPE(j) = .FALSE., then type j is not used. β€” !> β€” basically a yes/no list of which matrix types get invited to the party ✨ .TRUE. = you're on the list, .FALSE. = not today honey πŸ’…
  • NN β€” !> NN is INTEGER β€” !> The number of values of N contained in the vector NVAL. β€” !> β€” how many N values are living in NVAL fr fr
  • NVAL β€” !> NVAL is INTEGER array, dimension (NN) β€” !> The values of the matrix dimension N. β€” !> β€” the actual matrix dimensions, one per entry 😌
  • NNB β€” !> NNB is INTEGER β€” !> The number of values of NB contained in the vector NBVAL. β€” !> β€” headcount of block sizes in NBVAL
  • NBVAL β€” !> NBVAL is INTEGER array, dimension (NNB) β€” !> The values of the blocksize NB. β€” !> β€” the blocksizes themselves, iconic blocky behaviour 🧱
  • NNS β€” !> NNS is INTEGER β€” !> The number of values of NRHS contained in the vector NSVAL. β€” !> β€” how many right-hand-side counts are in NSVAL
  • NSVAL β€” !> NSVAL is INTEGER array, dimension (NNS) β€” !> The values of the number of right hand sides NRHS. β€” !> β€” the NRHS values, i.e. how many right-hand sides we're solving for πŸ™ˆ
  • 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 cutoff, the vibe check line 🌈 anything with RESULT >= THRESH makes it into the output file. want everything printed? set THRESH = 0 and prepare to be flooded πŸ’€
  • TSTERR β€” !> TSTERR is LOGICAL β€” !> Flag that indicates whether error exits are to be tested. β€” !> β€” .TRUE. means yes we're testing the error exits too, hold on tight 🫢
  • NMAX β€” !> NMAX is INTEGER β€” !> The maximum value permitted for N, used in dimensioning the β€” !> work arrays. β€” !> β€” the biggest N allowed, aka the reason all the work arrays are sized the way they are πŸ‘‘
  • A β€” !> A is REAL array, dimension (NMAX*NMAX) β€” !> β€” the matrix itself, no !> prose here, just vibes and NMAX*NMAX real numbers
  • AFAC β€” !> AFAC is REAL array, dimension (NMAX*NMAX) β€” !> β€” the factored version, same size, slay
  • AINV β€” !> AINV is REAL array, dimension (NMAX*NMAX) β€” !> β€” the inverse, same size again, consistent queen
  • B β€” !> B is REAL array, dimension (NMAX*NSMAX) β€” !> where NSMAX is the largest entry in NSVAL. β€” !> β€” right-hand side central πŸ’– note the NSMAX definition, that's NSMAX = largest entry in NSVAL, iykyk
  • X β€” !> X is REAL array, dimension (NMAX*NSMAX) β€” !> β€” the solution array, same dimensions as B πŸ¦‹
  • XACT β€” !> XACT is REAL array, dimension (NMAX*NSMAX) β€” !> β€” the exact solution, for comparison purposes, the reference bestie 🌸
  • WORK β€” !> WORK is REAL array, dimension (NMAX*max(3,NSMAX)) β€” !> β€” scratch space, sized NMAX*max(3,NSMAX), carry on ✨
  • RWORK β€” !> RWORK is REAL array, dimension (max(NMAX,2*NSMAX)) β€” !> β€” more scratch, this time max(NMAX,2*NSMAX) πŸŽ€
  • IWORK β€” !> IWORK is INTEGER array, dimension (2*NMAX) β€” !> β€” the integer scratch space, 2*NMAX, ints only obviously πŸ’…
  • NOUT β€” !> NOUT is INTEGER β€” !> The unit number for output. β€” !> β€” where all the output goes, the unit number, that's it, that's the whole job 😭

πŸ‘‘ Author πŸ‘‘

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

all four of them, credited together, a whole collab πŸ”₯

Definition at line 168 of file schksy_rook.f. β€” that's the exact spot, no cap πŸ“


🌺 Author 🌺

Generated automatically by Doxygen for LAPACK from the source code.

like, the docs wrote themselves bestie, Doxygen did that πŸ™ˆ


πŸ’–βœ¨ and that's the whole page βœ¨πŸ’– this was LAPACK, Version 3.12.0, served fresh from /home/abui...ksy_rook.f(3) β€” drink water, cite your sources, and remember: the rook pivots are rooting for you πŸ«ΆπŸŽ€πŸ¦‹

πŸ“¦ where this page comes from