lis_esolver...esidualnorm(3)

πŸ“¦ version 2.1.11, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

πŸ’– lis_esolver_get_residualnorm β€” bestie edition πŸ’–

okay so this is a page from the Lis Library Functions manual (the whole lis_esolver...esidualnorm(3) situation, iykyk) and honestly? it's a little baddie. let's get into it 🫢


✨ NAME ✨

lis_esolver_get_residualnorm β€” get the relative residual norm for the specified eigenpair from the eigensolver 🌸

like. it tells you how good your eigenpair is doing. a little vibe check for your math, fr fr.


✨ SYNOPSIS ✨

#include "lis.h"

LIS_INT lis_esolver_get_residualnorm(LIS_ESOLVER esolver, LIS_REAL
*residual);

yes bestie you gotta #include "lis.h" first, that's non-negotiable πŸ’…


✨ DESCRIPTION ✨

okay so what this does is: it gets the relative residual norm for the eigenpair you specified, straight from the eigensolver. and the formula, no cap, is literally:

||lx - Ax||_2/||lx||_2

that's it. that's the whole thing. it's giving "how far off am i" energy and honestly we love a self-aware function πŸ¦‹


✨ INPUT ✨

  • esolver β€” the eigensolver πŸ‘‘ (yes. that one. the eigensolver.)

✨ OUTPUT ✨

  • residual β€” the relative residual norm, and it is exactly ||lx - Ax||_2/||lx||_2 ✨

✨ EXIT STATUS ✨

the following exit values are returned, and you will be checking them:

  • 0 β€” the process is normally terminated πŸŽ€ slay, everything's fine, go off
  • unspecified β€” an error occurred 😭 not the vibe. something went wrong.
fr fr, don't just ignore the exit status. "unspecified" is doing a lot of heavy lifting there and it's not a compliment πŸ’€

✨ SEE ALSO ✨

go read lis(3) bestie, it's the main character of this whole franchise 🌈


and that's the tea πŸ“ this page came from the Lis Library Functions manual, dated 28 Aug 2014, and it lives at lis_esolver...esidualnorm(3). iconic behavior honestly. now go get those residual norms, you absolute legend πŸ’œβœ¨

πŸ“¦ where this page comes from