/home/abui...scnrm2.f90(3)

💅 NAME 💅

/home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/BLAS/SRC/scnrm2.f90

okay so bestie, this whole page is a Library Functions Manual situation, and the star of the show is that very long file path up there ⬆️ — that's literally the icon we're here to talk about. periodt.

---

✨ SYNOPSIS ✨

🎀 Functions/Subroutines 🎀

• real(wp) function SCNRM2 (n, x, incx) — this is the one, the main character: SCNRM2 itself 🫶

---

🌸 Function/Subroutine Documentation 🌸

real(wp) function SCNRM2 (integer n, complex(wp), dimension(*) x, integer incx)

SCNRM2 — say hi 👋

⭐ Purpose: ⭐

!> !> SCNRM2 returns the euclidean norm of a vector via the function !> name, so that !> !> SCNRM2 := sqrt( x**H*x ) !>

translation: it hands you back the euclidean norm of a vector, and the formula is right there — SCNRM2 := sqrt( x**H*x ) 🔥

💜 Parameters 💜

🌈 N

!> N is INTEGER !> number of elements in input vector(s) !>

it's an INTEGER, and it's literally just how many elements are chillin' in your input vector(s) ✨

🦋 X

!> X is COMPLEX array, dimension (N) !> complex vector with N elements !>

a COMPLEX array with dimension (N) — i.e. your complex vector that has N elements in it 💖

🍓 INCX

!> INCX is INTEGER, storage spacing between elements of X !> If INCX > 0, X(1+(i-1)*INCX) = x(i) for 1 <= i <= n !> If INCX < 0, X(1-(n-i)*INCX) = x(i) for 1 <= i <= n !> If INCX = 0, x isn't a vector so there is no need to call !> this subroutine. If you call it anyway, it will count x(1) !> in the vector norm N times. !>

INCX is an INTEGER and it's the storage spacing between elements of X. the breakdown:

• INCX > 0 → X(1+(i-1)*INCX) = x(i) for 1 <= i <= n 👑
• INCX < 0 → X(1-(n-i)*INCX) = x(i) for 1 <= i <= n 🧚
• INCX = 0 → bestie, x isn't a vector anymore, so there is literally no need to call this subroutine. if you call it anyway? it will count x(1) in the vector norm N times 😭💀 consider yourself warned.

🎀 Author 🎀

Edward Anderson, Lockheed Martin

🌸 Date 🌸

August 2016

🦋 Contributors: 🦋

Weslley Pereira, University of Colorado Denver, USA

💜 Further Details: 💜

!> !> Anderson E. (2017) !> Algorithm 978: Safe Scaling in the Level 1 BLAS !> ACM Trans Math Softw 44:1--28 !> https://doi.org/10.1145/3061665 !> !> Blue, James L. (1978) !> A Portable Fortran Program to Find the Euclidean Norm of a Vector !> ACM Trans Math Softw 4:15--23 !> https://doi.org/10.1145/355769.355771 !> !>

Definition at line 89 of file scnrm2.f90. 📌

---

⭐ Author ⭐

Generated automatically by Doxygen for LAPACK from the source code.

---

and that's the whole vibe check, bestie — this page is from LAPACK, Version 3.12.0, dated August 2016, and it was served to you fresh out of /home/abui...scnrm2.f90(3) 💅✨ bye ily 🫶