CDOTU(3)

πŸ“¦ version 3.12.0, in opensuse-leap 16.0

πŸ’… CDOTU(3) β€” like, the whole entire manual page, bestie

okay so real quick before we dive in: this page lives in the Library Functions Manual, and the file it's describing is cdotu.f(3) β€” yes the .f is doing main character energy, we love a Fortran moment. 🧚


🌸 NAME 🌸

/home/abuild/rpmbuild/BUILD/lapack-static-3.12.0-build/lapack-3.12.0/BLAS/SRC/cdotu.f

that's the whole name. it's a path. it's giving "my name is my address" and honestly? iconic. 😭 the file is literally just living at that exact spot, no cap.


✨ SYNOPSIS ✨

Functions/Subroutines

complex function CDOTU (n, cx, incx, cy, incy)
    CDOTU

that's it. that's the vibe. a complex function called CDOTU taking n, cx, incx, cy, incy. periodt. πŸ’…


πŸ¦‹ Function/Subroutine Documentation πŸ¦‹

here's the full glow-up of the signature, bestie:

complex function CDOTU (integer n, complex, dimension(*) cx, integer incx,
    complex, dimension(*) cy, integer incy)

CDOTU πŸ”₯

πŸŽ€ Purpose πŸŽ€

okay so the actual purpose, straight from the source with the doc-comment markers intact because we respect the original:

!>
!> CDOTU forms the dot product of two complex vectors
!>      CDOTU = X^T * Y
!>
!>

so yeah β€” it forms the dot product of two complex vectors, and the math is CDOTU = X^T * Y. that's the whole thing. slay. πŸ’–

🌈 Parameters 🌈

  • N β€” N is INTEGER, and it's the number of elements in input vector(s). so like, how many elements we're working with. the headcount. the guest list. 🫢
!>          N is INTEGER
!>         number of elements in input vector(s)
!>
  • CX β€” CX is COMPLEX array, dimension ( 1 + ( N - 1 )*abs( INCX ) ). that's the first vector, and the dimension formula is literally that, don't @ me. πŸ¦‹
!>          CX is COMPLEX array, dimension ( 1 + ( N - 1 )*abs( INCX ) )
!>
  • INCX β€” INCX is INTEGER, and it's the storage spacing between elements of CX. so it's how far apart the elements are chillin' in memory. πŸŽ€
!>          INCX is INTEGER
!>         storage spacing between elements of CX
!>
  • CY β€” CY is COMPLEX array, dimension ( 1 + ( N - 1 )*abs( INCY ) ). second vector, same deal, note the INCY in there instead. πŸ‘‘
!>          CY is COMPLEX array, dimension ( 1 + ( N - 1 )*abs( INCY ) )
!>
  • INCY β€” INCY is INTEGER, and it's the storage spacing between elements of CY. matching energy with INCX, as it should. ✨
!>          INCY is INTEGER
!>         storage spacing between elements of CY
!>

πŸ’œ Author πŸ’œ

the absolute legends behind this:

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

four institutions. one dot product. group project that actually ate. πŸ“

πŸ”₯ Further Details πŸ”₯

the historical receipts, kept exactly as written:

!>
!>     jack dongarra, linpack, 3/11/78.
!>     modified 12/3/93, array(1) declarations changed to array(*)
!>

so jack dongarra wrote it for linpack on 3/11/78, and then on 12/3/93 it got modified β€” specifically the array(1) declarations changed to array(*). a true glow-up moment, honestly. πŸ™ˆ

⭐ Definition at line 82 of file cdotu.f. ⭐

Definition at line 82 of file cdotu.f. β€” line 82, bestie. remember it. iykyk.


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for LAPACK from the source code.

so nobody hand-wrote this page β€” Doxygen did it automatically for LAPACK from the source code. robot intern energy but make it documentation. πŸ€–πŸ’…


πŸ’€ quick vibe check: this is auto-generated docs for a Fortran BLAS routine, so if you're quoting the parameter dims, quote the ( 1 + ( N - 1 )*abs( INCX ) ) bits exactly β€” they are doing math in there and we do not touch them.

okay that's the whole page, no skips, no crumbs left behind 🫢 this beauty is LAPACK Version 3.12.0, and it came to you straight from /home/abui...SRC/cdotu.f(3) β€” mwah, go forth and dot-product your complex vectors, bestie πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from