lapy3(3)

πŸŽ€ lapy3(3) β€” Library Functions Manual πŸŽ€

okay so bestie, you found the lapy3(3) page in the Library Functions Manual, and she is literally here to serve one iconic line: a robust sqrt( x^2 + y^2 + z^2 ). no cap, that's the whole assignment. πŸ’…

✨ NAME ✨

lapy3 - lapy3: robust sqrt( x^2 + y^2 + z^2 )

🌸 SYNOPSIS 🌸

okay so the synopsis has two function besties, and they're giving β€œsame energy, different precision.” 🫢

πŸ¦‹ Functions πŸ¦‹

  • double precision function dlapy3 (x, y, z) β€” DLAPY3 returns sqrt(x2+y2+z2).
  • real function slapy3 (x, y, z) β€” SLAPY3 returns sqrt(x2+y2+z2).

🧚 Detailed Description 🧚

this section is lowkey just the red carpet before the function documentation β€” the original doesn't add extra prose here, she just points you straight to the docs. periodt. ✨

πŸ’œ Function Documentation πŸ’œ

πŸ”₯ double precision function dlapy3 (double precision x, double precision y, double precision z) πŸ”₯

okay so first up is DLAPY3, and she returns sqrt(x2+y2+z2). iconic behavior. 🌈

Full signature, exactly as she appears:

double precision function dlapy3 (double precision x, double precision y,
       double precision z)

Purpose: the source says, in its own literal glow:

!>
!> DLAPY3 returns sqrt(x**2+y**2+z**2), taking care not to cause
!> unnecessary overflow and unnecessary underflow.
!>

so yeah, she's doing the robust norm thing and avoiding unnecessary overflow and unnecessary underflow. we love a careful queen. πŸ’š

Parameters:

  • X β€” the literal doc line is:
!>          X is DOUBLE PRECISION

and the source follows it with a !> line.

  • Y β€” the literal doc line is:
!>          Y is DOUBLE PRECISION

and the source follows it with a !> line.

  • Z β€” the literal doc lines are:
!>          Z is DOUBLE PRECISION
!>          X, Y and Z specify the values x, y and z.

and then a final !> line. so X, Y and Z specify the values x, y and z, bestie. πŸ“

Author:

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

Definition at line 67 of file dlapy3.f.


πŸ”₯ real function slapy3 (real x, real y, real z) πŸ”₯

next up is SLAPY3, the real-precision twin, and she also returns sqrt(x2+y2+z2). ate. πŸ’–

Full signature, exact:

real function slapy3 (real x, real y, real z)

Purpose: same energy, literal source block:

!>
!> SLAPY3 returns sqrt(x**2+y**2+z**2), taking care not to cause
!> unnecessary overflow and unnecessary underflow.
!>

again: no unnecessary overflow, no unnecessary underflow. careful and iconic. 😭

Parameters:

  • X β€” literal doc line:
!>          X is REAL

followed by a !> line.

  • Y β€” literal doc line:
!>          Y is REAL

followed by a !> line.

  • Z β€” literal doc lines:
!>          Z is REAL
!>          X, Y and Z specify the values x, y and z.

followed by a final !> line. so once again, X, Y and Z specify the values x, y and z. πŸŽ€

Author:

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

Definition at line 67 of file slapy3.f.

🌟 Author 🌟

Generated automatically by Doxygen for LAPACK from the source code.

okay bestie, that's the whole page β€” cute little sign-off from the footer: LAPACK Version 3.12.0, and there's no date listed on this one, so we're ending with the version and a big sparkly bye. πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from