rocblas_zhbmv Interface Reference#
hipfort_rocblas::rocblas_zhbmv Interface Reference
! More...
Public Member Functions | |
| integer(kind(rocblas_status_success)) function | rocblas_zhbmv_ (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy) |
| integer(kind(rocblas_status_success)) function | rocblas_zhbmv_full_rank (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy) |
| integer(kind(rocblas_status_success)) function | rocblas_zhbmv_rank_0 (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy) |
| integer(kind(rocblas_status_success)) function | rocblas_zhbmv_rank_1 (handle, uplo, n, k, alpha, A, lda, x, incx, beta, y, incy) |
Detailed Description
!
BLAS Level 2 API
\details
xHBMV performs the matrix-vector operations
y := alphaAx + betay
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.
@param[in]
handle [rocblas_handle]
handle to the rocblas library context queue.
@param[in]
uplo [rocblas_fill]
rocblas_fill_upper: The upper triangular part of A is being supplied.
rocblas_fill_lower: The lower triangular part of A is being supplied.
@param[in]
n [rocblas_int]
the order of the matrix A.
@param[in]
k [rocblas_int]
the number of super-diagonals of the matrix A. Must be >= 0.
@param[in]
alpha device pointer or host pointer to scalar alpha.
@param[in]
A device pointer storing matrix A. Of dimension (lda, n).
if uplo == rocblas_fill_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 == rocblas_fill_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.
@param[in]
lda [rocblas_int]
specifies the leading dimension of A. must be >= k + 1
@param[in]
x device pointer storing vector x.
@param[in]
incx [rocblas_int]
specifies the increment for the elements of x.
@param[in]
beta device pointer or host pointer to scalar beta.
@param[inout]
y device pointer storing vector y.
@param[in]
incy [rocblas_int]
specifies the increment for the elements of y.
Member Function/Subroutine Documentation
◆ rocblas_zhbmv_()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhbmv::rocblas_zhbmv_ | ( | type(c_ptr), value | handle, |
| integer(kind(rocblas_fill_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 | ||
| ) |
◆ rocblas_zhbmv_full_rank()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhbmv::rocblas_zhbmv_full_rank | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_fill_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 | ||
| ) |
◆ rocblas_zhbmv_rank_0()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhbmv::rocblas_zhbmv_rank_0 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_fill_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 | ||
| ) |
◆ rocblas_zhbmv_rank_1()
| integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zhbmv::rocblas_zhbmv_rank_1 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_fill_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: