This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipblaszhbmv Interface Reference

hipblaszhbmv Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszhbmv Interface Reference
hipfort_hipblas::hipblaszhbmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszhbmv_ (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblaszhbmv_full_rank (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblaszhbmv_rank_0 (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy)
 
integer(kind(hipblas_status_success)) function hipblaszhbmv_rank_1 (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy)
 

Detailed Description

BLAS Level 2 API.

hbmv performs the matrix-vector operations

y := alpha*A*x + beta*y

where alpha and beta are scalars, x and y are n element vectors and A is an n by n Hermitian band matrix, with k super-diagonals.

Parameters
[in]handle[hipblasHandle_t] handle to the hipblas library context queue.
[in]uplo[hipblasFillMode_t] HIPBLAS_FILL_MODE_UPPER: The upper triangular part of A is being supplied. HIPBLAS_FILL_MODE_LOWER: The lower triangular part of A is being supplied.
[in]n[int] the order of the matrix A.
[in]k[int] the number of super-diagonals of the matrix A. Must be >= 0.
[in]alphadevice pointer or host pointer to scalar alpha.
[in]Adevice pointer storing matrix A. Of dimension (lda, n). if uplo == HIPBLAS_FILL_MODE_UPPER: The leading (k + 1) by n part of A must contain the upper triangular band part of the Hermitian matrix, with the leading diagonal in row (k + 1), the first super-diagonal on the RHS of row k, etc. The top left k by x triangle of A will not be referenced. Ex (upper, lda = n = 4, k = 1): A Represented matrix (0,0) (5,9) (6,8) (7,7) (1, 0) (5, 9) (0, 0) (0, 0) (1,0) (2,0) (3,0) (4,0) (5,-9) (2, 0) (6, 8) (0, 0) (0,0) (0,0) (0,0) (0,0) (0, 0) (6,-8) (3, 0) (7, 7) (0,0) (0,0) (0,0) (0,0) (0, 0) (0, 0) (7,-7) (4, 0)

if uplo == HIPBLAS_FILL_MODE_LOWER: The leading (k + 1) by n part of A must contain the lower triangular band part of the Hermitian matrix, with the leading diagonal in row (1), the first sub-diagonal on the LHS of row 2, etc. The bottom right k by k triangle of A will not be referenced. Ex (lower, lda = 2, n = 4, k = 1): A Represented matrix (1,0) (2,0) (3,0) (4,0) (1, 0) (5,-9) (0, 0) (0, 0) (5,9) (6,8) (7,7) (0,0) (5, 9) (2, 0) (6,-8) (0, 0) (0, 0) (6, 8) (3, 0) (7,-7) (0, 0) (0, 0) (7, 7) (4, 0)

As a Hermitian matrix, the imaginary part of the main diagonal of A will not be referenced and is assumed to be == 0.

Parameters
[in]lda[int] specifies the leading dimension of A. must be >= k + 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

◆ hipblaszhbmv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhbmv::hipblaszhbmv_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  n,
integer(c_int), value  k,
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 
)

◆ hipblaszhbmv_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhbmv::hipblaszhbmv_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
integer(c_int)  k,
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 
)

◆ hipblaszhbmv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhbmv::hipblaszhbmv_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
integer(c_int)  k,
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 
)

◆ hipblaszhbmv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhbmv::hipblaszhbmv_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
integer(c_int)  k,
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: