TESTING/EIG/zcklse.f(3)

📦
version 3.12.1 · 2 versions
, in arch rolling

💅 TESTING/EIG/zcklse.f

okay so bestie, welcome to TESTING/EIG/zcklse.f — this is a <pink>library functions manual</pink> page and honestly it's giving "test-subroutine that does the absolute most." buckle up 🎀

✨ SYNOPSIS ✨

🧚 Functions/Subroutines

  • subroutine zcklse (nn, mval, pval, nval, nmats, iseed, thresh, nmax, a, af, b, bf, x, work, rwork, nin, nout, info) — the one and only <purple>ZCKLSE</purple> 💜

🌸 Function/Subroutine Documentation 🌸

👑 subroutine zcklse

here's the full glow-up of the signature, copied <mint>exactly</mint> because we do not mess with the source, periodt:

subroutine zcklse (integer nn, integer, dimension( * ) mval, integer,
     dimension( * ) pval, integer, dimension( * ) nval, integer nmats,
     integer, dimension( 4 ) iseed, double precision thresh, integer nmax,
     complex*16, dimension( * ) a, complex*16, dimension( * ) af, complex*16,
     dimension( * ) b, complex*16, dimension( * ) bf, complex*16, dimension(
     * ) x, complex*16, dimension( * ) work, double precision, dimension( * )
     rwork, integer nin, integer nout, integer info)

ZCKLSE 🔥

💫 Purpose:

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

so yeah, this lil icon's whole job is <hotpink>testing ZGGLSE, the subroutine that handles the linear equality constrained least square problem, aka <cyan>LSE</cyan>. it's giving quality control with main character energy 👑

🦋 Parameters

NN

!> NN is INTEGER !> The number of values of (M,P,N) contained in the vectors !> (MVAL, PVAL, NVAL). !>

so NN is the cute little count of how many (M,P,N) triples are chilling inside the vectors (MVAL, PVAL, NVAL) ✨

MVAL

!> MVAL is INTEGER array, dimension (NN) !> The values of the matrix row(column) dimension M. !>

an INTEGER array, dimension (NN), holding the values of the matrix row(column) dimension M 💅

PVAL

!> PVAL is INTEGER array, dimension (NN) !> The values of the matrix row(column) dimension P. !>

an INTEGER array, dimension (NN), holding the values of the matrix row(column) dimension P 💅

NVAL

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

an INTEGER array, dimension (NN), holding the values of the matrix column(row) dimension N 💅

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. !>

NMATS is INTEGER and it's literally the number of matrix types to be tested for each combination of matrix dimensions. if NMATS >= NTYPES (that's the max number of matrix types), then <green>all</green> the different types get generated for testing. but if NMATS < NTYPES, another input line gets read to grab the numbers of the matrix types to be used. no cap 🫶

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. !>

ISEED is an INTEGER array, dimension (4) — the seed of the random number generator 🌈

  • on entry: the array elements should be between 0 and 4095, otherwise they get <yellow>reduced mod 4096</yellow>, and ISEED(4) <red>must be odd</red> ⚠️
  • on exit: the next seed in the random number sequence after all the test matrices have been generated 🔮

THRESH

!> THRESH is DOUBLE PRECISION !> 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. !>

THRESH is DOUBLE PRECISION, the threshold value for the test ratios. a result gets included in the output file if RESULT >= THRESH. and if you want <hotpink>every</hotpink> single test ratio printed? set THRESH = 0 🍓

NMAX

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

NMAX is INTEGER — the max value permitted for M or N, and it's used in dimensioning the work arrays 📐

A

!> A is COMPLEX*16 array, dimension (NMAX*NMAX) !>

A is a COMPLEX*16 array, dimension (NMAX*NMAX) 💖

AF

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

AF is a COMPLEX*16 array, dimension (NMAX*NMAX) 💖

B

!> B is COMPLEX*16 array, dimension (NMAX*NMAX) !>

B is a COMPLEX*16 array, dimension (NMAX*NMAX) 💖

BF

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

BF is a COMPLEX*16 array, dimension (NMAX*NMAX) 💖

X

!> X is COMPLEX*16 array, dimension (5*NMAX) !>

X is a COMPLEX*16 array, dimension (5*NMAX) — yes, <purple>5*NMAX</purple>, not NMAX*NMAX, she's special like that ✨

WORK

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

WORK is a COMPLEX*16 array, dimension (NMAX*NMAX) 💖

RWORK

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

RWORK is a DOUBLE PRECISION array, dimension (NMAX) 🌸

NIN

!> NIN is INTEGER !> The unit number for input. !>

NIN is INTEGER — the unit number for input 📥

NOUT

!> NOUT is INTEGER !> The unit number for output. !>

NOUT is INTEGER — the unit number for output 📤

INFO

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

INFO is INTEGER and here's the vibe check:

  • = 0 : successful exit 🎉
  • > 0 : if ZLATMS returns an error code, the absolute value of it is returned 😭

🌟 Author

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

Definition at line 165 of file zcklse.f. 📍

💜 Author

Generated automatically by Doxygen for LAPACK from the source code. (the robots did this one, respect 🫡)

ngl bestie that's the whole page — every flag, every array dimension, every caveat, untouched. iykyk 💅

later, legend — this page came from LAPACK, Version 3.12.0, for TESTING/EIG/zcklse.f(3). go forth and test those LSEs, periodt 🎀🦋✨

📦 where this page comes from