BLAS/SRC/scnrm2.f90(3)

📦
version 3.12.1 · 5 versions
, in arch rolling

💅 BLAS/SRC/scnrm2.f90

okay so like, welcome to the manual page for BLAS/SRC/scnrm2.f90, bestie — a whole library function page and honestly it's giving main character energy ✨

🌸 SYNOPSIS

Functions/Subroutines

  • real(wp) function scnrm2 (n, x, incx) — the one and only SCNRM2, she's here 🎀

🦋 Function/Subroutine Documentation

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

SCNRM2 — literally her ✨

🫶 Purpose:

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

so basically she hands you back the euclidean norm of a vector, using the function name itself, like:

SCNRM2 := sqrt( x**H*x )

no cap, that's the whole vibe 💖

🔥 Parameters

  • N — N is INTEGER, the number of elements in your input vector(s). that's it, that's the count 🙈
  • X — X is COMPLEX array, dimension (N), a complex vector with N elements. iconic array behavior 💅
  • INCX — INCX is INTEGER, the storage spacing between elements of X. and here's the breakdown, iykyk:
    • 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.
fr fr, INCX = 0 means x isn't a vector at all, so like… there's literally no reason to call this. but if you do it anyway?? it's gonna count x(1) in the vector norm N times. not me warning you 🫣

👑 Author

Edward Anderson, Lockheed Martin. periodt.

📅 Date

August 2016.

💜 Contributors:

Weslley Pereira, University of Colorado Denver, USA. slay 🎀

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

the receipts, bestie 📚✨

📍 Definition at line 89 of file scnrm2.f90.

⭐ Author

Generated automatically by Doxygen for LAPACK from the source code. not a human, just vibes 🤖💫

okay that's the whole page, hope this ate 💅🌸 — this cute little sign-off is brought to you by LAPACK, Version 3.12.0, dated in the footer of BLAS/SRC/scnrm2.f90(3). bye bestie, go compute some norms 🦋💖

📦 where this page comes from