hipblaszgbmv Interface Reference

hipblaszgbmv Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszgbmv Interface Reference
hipfort_hipblas::hipblaszgbmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszgbmv_ (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblaszgbmv_full_rank (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblaszgbmv_rank_0 (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblaszgbmv_rank_1 (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy)
 

Detailed Description

BLAS Level 2 API.

gbmv performs one of the matrix-vector operations

y := alpha*A*x    + beta*y,   or
y := alpha*A**T*x + beta*y,   or
y := alpha*A**H*x + beta*y,

where alpha and beta are scalars, x and y are vectors and A is an m by n banded matrix with kl sub-diagonals and ku super-diagonals.

Parameters
[in]handle[hipblasHandle_t] handle to the hipblas library context queue.
[in]trans[hipblasOperation_t] indicates whether matrix A is tranposed (conjugated) or not
[in]m[int] number of rows of matrix A
[in]n[int] number of columns of matrix A
[in]kl[int] number of sub-diagonals of A
[in]ku[int] number of super-diagonals of A
[in]alphadevice pointer or host pointer to scalar alpha.
[in]Adevice pointer storing banded matrix A. Leading (kl + ku + 1) by n part of the matrix contains the coefficients of the banded matrix. The leading diagonal resides in row (ku + 1) with the first super-diagonal above on the RHS of row ku. The first sub-diagonal resides below on the LHS of row ku + 2. This propogates up and down across sub/super-diagonals. Ex: (m = n = 7; ku = 2, kl = 2) 1 2 3 0 0 0 0 0 0 3 3 3 3 3 4 1 2 3 0 0 0 0 2 2 2 2 2 2 5 4 1 2 3 0 0 -—> 1 1 1 1 1 1 1 0 5 4 1 2 3 0 4 4 4 4 4 4 0 0 0 5 4 1 2 0 5 5 5 5 5 0 0 0 0 0 5 4 1 2 0 0 0 0 0 0 0 0 0 0 0 5 4 1 0 0 0 0 0 0 0 Note that the empty elements which don't correspond to data will not be referenced.
[in]lda[int] specifies the leading dimension of A. Must be >= (kl + ku + 1)
[in]xdevice pointer storing vector x.
[in]incx[int] specifies the increment for the elements of x.
[in]betadevice pointer or host pointer to scalar beta.
[in,out]ydevice pointer storing vector y.
[in]incy[int] specifies the increment for the elements of y.

Member Function/Subroutine Documentation

◆ hipblaszgbmv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmv::hipblaszgbmv_ ( type(c_ptr), value  handle,
integer(kind(hipblas_op_n)), value  trans,
integer(c_int), value  m,
integer(c_int), value  n,
integer(c_int), value  kl,
integer(c_int), value  ku,
complex(c_double_complex)  alpha,
type(c_ptr), value  A,
integer(c_int), value  lda,
type(c_ptr), value  x,
integer(c_int), value  incx,
complex(c_double_complex)  beta,
type(c_ptr), value  y,
integer(c_int), value  incy 
)

◆ hipblaszgbmv_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmv::hipblaszgbmv_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  m,
integer(c_int)  n,
integer(c_int)  kl,
integer(c_int)  ku,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:,:), target  A,
integer(c_int)  lda,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx,
complex(c_double_complex)  beta,
complex(c_double_complex), dimension(:), target  y,
integer(c_int)  incy 
)

◆ hipblaszgbmv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmv::hipblaszgbmv_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  m,
integer(c_int)  n,
integer(c_int)  kl,
integer(c_int)  ku,
complex(c_double_complex)  alpha,
complex(c_double_complex), target  A,
integer(c_int)  lda,
complex(c_double_complex), target  x,
integer(c_int)  incx,
complex(c_double_complex)  beta,
complex(c_double_complex), target  y,
integer(c_int)  incy 
)

◆ hipblaszgbmv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmv::hipblaszgbmv_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_op_n))  trans,
integer(c_int)  m,
integer(c_int)  n,
integer(c_int)  kl,
integer(c_int)  ku,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx,
complex(c_double_complex)  beta,
complex(c_double_complex), dimension(:), target  y,
integer(c_int)  incy 
)

The documentation for this interface was generated from the following file: