hipblassgbmv Interface Reference

• hipfort_hipblas
• hipblassgbmv

Public Member Functions | List of all members

hipfort_hipblas::hipblassgbmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblassgbmv_ (handle, trans, m, n, kl, ku, alpha, ap, lda, x, incx, beta, y, incy)
integer(kind(hipblas_status_success)) function	hipblassgbmv_rank_0 (handle, trans, m, n, kl, ku, alpha, ap, lda, x, incx, beta, y, incy)
integer(kind(hipblas_status_success)) function	hipblassgbmv_rank_1 (handle, trans, m, n, kl, ku, alpha, ap, lda, x, incx, beta, y, incy)
integer(kind(hipblas_status_success)) function	hipblassgbmv_full_rank (handle, trans, m, n, kl, ku, alpha, ap, lda, x, incx, beta, y, incy)

Detailed Description

BLAS Level 2 API.

The gbmv functions perform 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.

• Supported precisions in rocBLAS : s, d, c, and z.
• Supported precisions in cuBLAS : s, d, c, and z.

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]	alpha	- device pointer or host pointer to scalar alpha.
[in]	AP	- device pointer storing banded matrix A. The 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 propagates 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 empty elements that don't correspond to data will not be referenced.
[in]	lda	- [int] specifies the leading dimension of A. Must be >= (kl + ku + 1).
[in]	x	- device pointer storing vector x.
[in]	incx	- [int] specifies the increment for the elements of x.
[in]	beta	- device pointer or host pointer to scalar beta.
[in,out]	y	- device pointer storing vector y.
[in]	incy	- [int] specifies the increment for the elements of y.

Member Function/Subroutine Documentation

◆ hipblassgbmv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmv::hipblassgbmv_	(	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,
		real(c_float)	alpha,
		type(c_ptr), value	ap,
		integer(c_int), value	lda,
		type(c_ptr), value	x,
		integer(c_int), value	incx,
		real(c_float)	beta,
		type(c_ptr), value	y,
		integer(c_int), value	incy
	)

◆ hipblassgbmv_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmv::hipblassgbmv_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,
		real(c_float)	alpha,
		real(c_float), dimension(:,:), target	ap,
		integer(c_int)	lda,
		real(c_float), dimension(:), target	x,
		integer(c_int)	incx,
		real(c_float)	beta,
		real(c_float), dimension(:), target	y,
		integer(c_int)	incy
	)

◆ hipblassgbmv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmv::hipblassgbmv_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,
		real(c_float)	alpha,
		real(c_float), target	ap,
		integer(c_int)	lda,
		real(c_float), target	x,
		integer(c_int)	incx,
		real(c_float)	beta,
		real(c_float), target	y,
		integer(c_int)	incy
	)

◆ hipblassgbmv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmv::hipblassgbmv_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,
		real(c_float)	alpha,
		real(c_float), dimension(:), target	ap,
		integer(c_int)	lda,
		real(c_float), dimension(:), target	x,
		integer(c_int)	incx,
		real(c_float)	beta,
		real(c_float), dimension(:), target	y,
		integer(c_int)	incy
	)

---

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

• hipfort_hipblas.F90