la_gbamv(3)

NAME πŸ’…

la_gbamv β€” la_gbamv: matrix-vector multiply |A| * |x|, general banded. That's the whole vibe. No transpose trickery at the caller level, no drama β€” just a banded matrix, absolute values everywhere, and a vector multiply that lives for error bounds. πŸŽ€


SYNOPSIS ✨

Functions πŸ¦‹

  • cla_gbamv β€” the complex flavor. CLA_GBAMV performs a matrix-vector operation to calculate error bounds. πŸ’–
subroutine cla_gbamv (trans, m, n, kl, ku, alpha, ab, ldab, x, incx,
    beta, y, incy)
  • dla_gbamv β€” the double precision one. DLA_GBAMV performs a matrix-vector operation to calculate error bounds. πŸ”₯
subroutine dla_gbamv (trans, m, n, kl, ku, alpha, ab, ldab, x, incx,
    beta, y, incy)
  • sla_gbamv β€” single precision, same energy. SLA_GBAMV performs a matrix-vector operation to calculate error bounds. 🌸
subroutine sla_gbamv (trans, m, n, kl, ku, alpha, ab, ldab, x, incx,
    beta, y, incy)
  • zla_gbamv β€” double complex, main character energy. ZLA_GBAMV performs a matrix-vector operation to calculate error bounds. πŸ‘‘
subroutine zla_gbamv (trans, m, n, kl, ku, alpha, ab, ldab, x, incx,
    beta, y, incy)

DETAILED DESCRIPTION 🫢

okay so Detailed Description is the section header, and everything juicy lives right below it in Function Documentation. no cap, that's where the good stuff is.


FUNCTION DOCUMENTATION πŸ’œ

subroutine cla_gbamv πŸ¦‹

subroutine cla_gbamv (integer trans, integer m, integer n, integer kl,
    integer ku, real alpha, complex, dimension( ldab, * ) ab, integer ldab,
    complex, dimension( * ) x, integer incx, real beta, real, dimension( * )
    y, integer incy)

CLA_GBAMV performs a matrix-vector operation to calculate error bounds.

Purpose 🎯

bestie, this routine does one of these two matrix-vector operations:

      y := alpha*abs(A)*abs(x) + beta*abs(y),
 or   y := alpha*abs(A)**T*abs(x) + beta*abs(y),

where alpha and beta are scalars, x and y are vectors, and A is an m by n matrix. literally the whole plot.

so like, this function is primarily used in calculating error bounds. to protect against underflow during evaluation, components in the resulting vector are perturbed away from zero by (N+1) times the underflow threshold. that's not optional, that's the safety net. but β€” and this is the iconic part β€” to prevent unnecessarily large errors for block-structure embedded in general matrices, zero components are not perturbed. A zero entry is considered if all multiplications involved in computing that entry have at least one zero multiplicand. ✨

Parameters πŸŽ€

  • TRANS β€” INTEGER. On entry, TRANS specifies the operation to be performed, like so:
BLAS_NO_TRANS      y := alpha*abs(A)*abs(x) + beta*abs(y)
BLAS_TRANS         y := alpha*abs(A**T)*abs(x) + beta*abs(y)
BLAS_CONJ_TRANS    y := alpha*abs(A**T)*abs(x) + beta*abs(y)

yep, BLAS_CONJ_TRANS produces the exact same line as BLAS_TRANS here β€” iykyk. Unchanged on exit. πŸ’…

  • M β€” INTEGER. On entry, M specifies the number of rows of the matrix A. M must be at least zero. Unchanged on exit.
  • N β€” INTEGER. On entry, N specifies the number of columns of the matrix A. N must be at least zero. Unchanged on exit.
  • KL β€” INTEGER. The number of subdiagonals within the band of A. KL >= 0. πŸ¦‹
  • KU β€” INTEGER. The number of superdiagonals within the band of A. KU >= 0. πŸ¦‹
  • ALPHA β€” REAL. On entry, ALPHA specifies the scalar alpha. Unchanged on exit.
  • AB β€” COMPLEX array, dimension (LDAB,n). Before entry, the leading m by n part of the array AB must contain the matrix of coefficients. Unchanged on exit. the band storage icon.
  • LDAB β€” INTEGER. On entry, LDAB specifies the first dimension of AB as declared in the calling (sub) program. LDAB must be at least max( 1, m ). Unchanged on exit.
  • X β€” COMPLEX array, dimension ( 1 + ( n - 1 )*abs( INCX ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( m - 1 )*abs( INCX ) ) otherwise. Before entry, the incremented array X must contain the vector x. Unchanged on exit. 🌈
  • INCX β€” INTEGER. On entry, INCX specifies the increment for the elements of X. INCX must not be zero. fr fr, not zero. Unchanged on exit.
  • BETA β€” REAL. On entry, BETA specifies the scalar beta. When BETA is supplied as zero then Y need not be set on input. Unchanged on exit. πŸ’€
  • Y β€” REAL array, dimension ( 1 + ( m - 1 )*abs( INCY ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( n - 1 )*abs( INCY ) ) otherwise. Before entry with BETA non-zero, the incremented array Y must contain the vector y. On exit, Y is overwritten by the updated vector y. If either m or n is zero, then Y not referenced and the function performs a quick return. shortcut era. ⭐
  • INCY β€” INTEGER. On entry, INCY specifies the increment for the elements of Y. INCY must not be zero. Unchanged on exit.
Level 2 Blas routine. 🫢

Author πŸ‘‘

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

Definition at line 186 of file cla_gbamv.f.


subroutine dla_gbamv πŸ”₯

subroutine dla_gbamv (integer trans, integer m, integer n, integer kl,
    integer ku, double precision alpha, double precision, dimension( ldab, *
    ) ab, integer ldab, double precision, dimension( * ) x, integer incx,
    double precision beta, double precision, dimension( * ) y, integer incy)

DLA_GBAMV performs a matrix-vector operation to calculate error bounds.

Purpose 🎯

same storyline, double precision edition. it performs one of these two matrix-vector operations:

      y := alpha*abs(A)*abs(x) + beta*abs(y),
 or   y := alpha*abs(A)**T*abs(x) + beta*abs(y),

where alpha and beta are scalars, x and y are vectors, and A is an m by n matrix. we been knew.

this function is primarily used in calculating error bounds. to protect against underflow during evaluation, components in the resulting vector are perturbed away from zero by (N+1) times the underflow threshold. but to prevent unnecessarily large errors for block-structure embedded in general matrices, zero components are not perturbed. A zero entry is considered if all multiplications involved in computing that entry have at least one zero multiplicand. ✨

Parameters πŸŽ€

  • TRANS β€” INTEGER. On entry, TRANS specifies the operation to be performed, as follows:
BLAS_NO_TRANS      y := alpha*abs(A)*abs(x) + beta*abs(y)
BLAS_TRANS         y := alpha*abs(A**T)*abs(x) + beta*abs(y)
BLAS_CONJ_TRANS    y := alpha*abs(A**T)*abs(x) + beta*abs(y)

Unchanged on exit. πŸ’…

  • M β€” INTEGER. On entry, M specifies the number of rows of the matrix A. M must be at least zero. Unchanged on exit.
  • N β€” INTEGER. On entry, N specifies the number of columns of the matrix A. N must be at least zero. Unchanged on exit.
  • KL β€” INTEGER. The number of subdiagonals within the band of A. KL >= 0. πŸ¦‹
  • KU β€” INTEGER. The number of superdiagonals within the band of A. KU >= 0. πŸ¦‹
  • ALPHA β€” DOUBLE PRECISION. On entry, ALPHA specifies the scalar alpha. Unchanged on exit.
  • AB β€” DOUBLE PRECISION array, dimension ( LDAB, n ). Before entry, the leading m by n part of the array AB must contain the matrix of coefficients. Unchanged on exit. band storage stays booked and busy.
  • LDAB β€” INTEGER. On entry, LDA specifies the first dimension of AB as declared in the calling (sub) program. LDAB must be at least max( 1, m ). Unchanged on exit. (yes, it says LDA right there in the source β€” we don't edit the source, we respect it πŸ™ˆ)
  • X β€” DOUBLE PRECISION array, dimension ( 1 + ( n - 1 )*abs( INCX ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( m - 1 )*abs( INCX ) ) otherwise. Before entry, the incremented array X must contain the vector x. Unchanged on exit. 🌈
  • INCX β€” INTEGER. On entry, INCX specifies the increment for the elements of X. INCX must not be zero. Unchanged on exit.
  • BETA β€” DOUBLE PRECISION. On entry, BETA specifies the scalar beta. When BETA is supplied as zero then Y need not be set on input. Unchanged on exit. πŸ’€
  • Y β€” DOUBLE PRECISION array, dimension ( 1 + ( m - 1 )*abs( INCY ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( n - 1 )*abs( INCY ) ) otherwise. Before entry with BETA non-zero, the incremented array Y must contain the vector y. On exit, Y is overwritten by the updated vector y. If either m or n is zero, then Y not referenced and the function performs a quick return. quick return my beloved. ⭐
  • INCY β€” INTEGER. On entry, INCY specifies the increment for the elements of Y. INCY must not be zero. Unchanged on exit.
Level 2 Blas routine. 🫢

Author πŸ‘‘

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

Definition at line 185 of file dla_gbamv.f.


(the s and z flavors are right behind this β€” same routine, same rules, different precision πŸ’–)

πŸŒ€ sla_gbamv β€” the real-valued one

subroutine sla_gbamv (integer trans, integer m, integer n, integer kl,
    integer ku, real alpha, real, dimension( ldab, * ) ab, integer ldab,
    real, dimension( * ) x, integer incx, real beta, real, dimension( * ) y,
    integer incy)

SLA_GBAMV performs a matrix-vector operation to calculate error bounds. That's the whole gig, bestie.

✨ Purpose

SLA_GBAMV performs one of these matrix-vector operations:

y := alpha*abs(A)*abs(x) + beta*abs(y),
or   y := alpha*abs(A)**T*abs(x) + beta*abs(y),

where alpha and beta are scalars, x and y are vectors and A is an m by n matrix.

This function is primarily used in calculating error bounds. To protect against underflow during evaluation, components in the resulting vector are perturbed away from zero by (N+1) times the underflow threshold. To prevent unnecessarily large errors for block-structure embedded in general matrices, zero components are not perturbed. A zero entry is considered if all multiplications involved in computing that entry have at least one zero multiplicand. That's the whole safety mechanism, and yes it's giving "we padded it so it doesn't vanish into the void" πŸ’…

πŸŽ€ Parameters

  • TRANS β€” INTEGER. On entry, TRANS specifies the operation to be performed as follows:
BLAS_NO_TRANS      y := alpha*abs(A)*abs(x) + beta*abs(y)
BLAS_TRANS         y := alpha*abs(A**T)*abs(x) + beta*abs(y)
BLAS_CONJ_TRANS    y := alpha*abs(A**T)*abs(x) + beta*abs(y)

Unchanged on exit.

  • M β€” INTEGER. On entry, M specifies the number of rows of the matrix A. M must be at least zero. Unchanged on exit.
  • N β€” INTEGER. On entry, N specifies the number of columns of the matrix A. N must be at least zero. Unchanged on exit.
  • KL β€” INTEGER. The number of subdiagonals within the band of A. KL >= 0.
  • KU β€” INTEGER. The number of superdiagonals within the band of A. KU >= 0.
  • ALPHA β€” REAL. On entry, ALPHA specifies the scalar alpha. Unchanged on exit.
  • AB β€” REAL array, dimension ( LDAB, n ). Before entry, the leading m by n part of the array AB must contain the matrix of coefficients. Unchanged on exit.
  • LDAB β€” INTEGER. On entry, LDA specifies the first dimension of AB as declared in the calling (sub) program. LDAB must be at least max( 1, m ). Unchanged on exit. Yes, it says LDA right there in the source β€” we don't make the rules, we just report them πŸ’€
  • X β€” REAL array, dimension ( 1 + ( n - 1 )*abs( INCX ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( m - 1 )*abs( INCX ) ) otherwise. Before entry, the incremented array X must contain the vector x. Unchanged on exit.
  • INCX β€” INTEGER. On entry, INCX specifies the increment for the elements of X. INCX must not be zero. Unchanged on exit.
  • BETA β€” REAL. On entry, BETA specifies the scalar beta. When BETA is supplied as zero then Y need not be set on input. Unchanged on exit.
  • Y β€” REAL array, dimension ( 1 + ( m - 1 )*abs( INCY ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( n - 1 )*abs( INCY ) ) otherwise. Before entry with BETA non-zero, the incremented array Y must contain the vector y. On exit, Y is overwritten by the updated vector y. If either m or n is zero, then Y not referenced and the function performs a quick return.
  • INCY β€” INTEGER. On entry, INCY specifies the increment for the elements of Y. INCY must not be zero. Unchanged on exit.
Level 2 Blas routine. That's it, that's the note.

🌈 Author

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

Definition at line 185 of file sla_gbamv.f.


🌸 zla_gbamv β€” the complex*16 glow-up

subroutine zla_gbamv (integer trans, integer m, integer n, integer kl,
    integer ku, double precision alpha, complex*16, dimension( ldab, * ) ab,
    integer ldab, complex*16, dimension( * ) x, integer incx, double
    precision beta, double precision, dimension( * ) y, integer incy)

ZLA_GBAMV performs a matrix-vector operation to calculate error bounds. Same energy, different precision.

✨ Purpose

ZLA_GBAMV performs one of these matrix-vector operations:

y := alpha*abs(A)*abs(x) + beta*abs(y),
or   y := alpha*abs(A)**T*abs(x) + beta*abs(y),

where alpha and beta are scalars, x and y are vectors and A is an m by n matrix.

This function is primarily used in calculating error bounds. To protect against underflow during evaluation, components in the resulting vector are perturbed away from zero by (N+1) times the underflow threshold. To prevent unnecessarily large errors for block-structure embedded in general matrices, zero components are not perturbed. A zero entry is considered if all multiplications involved in computing that entry have at least one zero multiplicand. The underflow protection is lowkey the main character here 🫢

πŸŽ€ Parameters

  • TRANS β€” INTEGER. On entry, TRANS specifies the operation to be performed as follows:
BLAS_NO_TRANS      y := alpha*abs(A)*abs(x) + beta*abs(y)
BLAS_TRANS         y := alpha*abs(A**T)*abs(x) + beta*abs(y)
BLAS_CONJ_TRANS    y := alpha*abs(A**T)*abs(x) + beta*abs(y)

Unchanged on exit.

  • M β€” INTEGER. On entry, M specifies the number of rows of the matrix A. M must be at least zero. Unchanged on exit.
  • N β€” INTEGER. On entry, N specifies the number of columns of the matrix A. N must be at least zero. Unchanged on exit.
  • KL β€” INTEGER. The number of subdiagonals within the band of A. KL >= 0.
  • KU β€” INTEGER. The number of superdiagonals within the band of A. KU >= 0.
  • ALPHA β€” DOUBLE PRECISION. On entry, ALPHA specifies the scalar alpha. Unchanged on exit.
  • AB β€” COMPLEX*16 array, dimension ( LDAB, n ). Before entry, the leading m by n part of the array AB must contain the matrix of coefficients. Unchanged on exit.
  • LDAB β€” INTEGER. On entry, LDAB specifies the first dimension of AB as declared in the calling (sub) program. LDAB must be at least max( 1, m ). Unchanged on exit. See? This one says LDAB. Character development πŸ’…
  • X β€” COMPLEX*16 array, dimension ( 1 + ( n - 1 )*abs( INCX ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( m - 1 )*abs( INCX ) ) otherwise. Before entry, the incremented array X must contain the vector x. Unchanged on exit.
  • INCX β€” INTEGER. On entry, INCX specifies the increment for the elements of X. INCX must not be zero. Unchanged on exit.
  • BETA β€” DOUBLE PRECISION. On entry, BETA specifies the scalar beta. When BETA is supplied as zero then Y need not be set on input. Unchanged on exit.
  • Y β€” DOUBLE PRECISION array, dimension ( 1 + ( m - 1 )*abs( INCY ) ) when TRANS = 'N' or 'n' and at least ( 1 + ( n - 1 )*abs( INCY ) ) otherwise. Before entry with BETA non-zero, the incremented array Y must contain the vector y. On exit, Y is overwritten by the updated vector y. If either m or n is zero, then Y not referenced and the function performs a quick return.
  • INCY β€” INTEGER. On entry, INCY specifies the increment for the elements of Y. INCY must not be zero. Unchanged on exit.
Level 2 Blas routine. Same note, same iconic status.

🌈 Author

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

Definition at line 186 of file zla_gbamv.f.


πŸ¦‹ Author (the meta one)

Generated automatically by Doxygen for LAPACK from the source code. Not me being generated by Doxygen, that's so real πŸŽ€


And that's the whole page, bestie. This was LAPACK Version 3.12.0, manual page la_gbamv(3) β€” go forth and compute those error bounds with main character energy. Periodt. πŸ’–βœ¨

πŸ“¦ where this page comes from