hipblasstbmv Interface Reference

• hipfort_hipblas
• hipblasstbmv

Public Member Functions | List of all members

hipfort_hipblas::hipblasstbmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblasstbmv_ (handle, uplo, transa, diag, n, k, ap, lda, x, incx)
integer(kind(hipblas_status_success)) function	hipblasstbmv_rank_0 (handle, uplo, transa, diag, n, k, ap, lda, x, incx)
integer(kind(hipblas_status_success)) function	hipblasstbmv_rank_1 (handle, uplo, transa, diag, n, k, ap, lda, x, incx)
integer(kind(hipblas_status_success)) function	hipblasstbmv_full_rank (handle, uplo, transa, diag, n, k, ap, lda, x, incx)

Detailed Description

BLAS Level 2 API.

The tbmv functions perform one of the matrix-vector operations:

x := A*x      or
x := A**T*x   or
x := A**H*x,

where x is a vector and A is a banded n by n matrix (see description below).

• 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]	uplo	- [hipblasFillMode_t] HIPBLAS_FILL_MODE_UPPER: A is an upper banded triangular matrix. HIPBLAS_FILL_MODE_LOWER: A is a lower banded triangular matrix.
[in]	transA	- [hipblasOperation_t] indicates whether matrix A is tranposed (conjugated) or not.
[in]	diag	- [hipblasDiagType_t] HIPBLAS_DIAG_UNIT: The main diagonal of A is assumed to consist of only 1's and is not referenced. HIPBLAS_DIAG_NON_UNIT: No assumptions are made of A's main diagonal.
[in]	n	- [int] the number of rows and columns of the matrix represented by A.
[in]	k	- [int] if uplo == HIPBLAS_FILL_MODE_UPPER, k specifies the number of super-diagonals of the matrix A. if uplo == HIPBLAS_FILL_MODE_LOWER, k specifies the number of sub-diagonals of the matrix A. k must satisfy k > 0 && k < lda.
[in]	AP	- device pointer storing banded triangular matrix A. if uplo == HIPBLAS_FILL_MODE_UPPER: The matrix represented is an upper banded triangular matrix with the main diagonal and k super-diagonals. Everything else can be assumed to be 0. The matrix is compacted so that the main diagonal resides on the k'th row, the first super diagonal resides on the RHS of the k-1'th row, and so forth, with the k'th diagonal on the RHS of the 0'th row. Ex: (HIPBLAS_FILL_MODE_UPPER; n = 5; k = 2) 1 6 9 0 0 -> 0 0 9 8 7 0 2 7 8 0 -> 0 6 7 8 9 0 0 3 8 7 -> 1 2 3 4 5 0 0 0 4 9 -> 0 0 0 0 0 0 0 0 0 5 -> 0 0 0 0 0 if uplo == HIPBLAS_FILL_MODE_LOWER: The matrix represnted is a lower banded triangular matrix with the main diagonal and k sub-diagonals. Everything else can be assumed to be 0. The matrix is compacted so that the main diagonal resides on the 0'th row, working up to the k'th diagonal residing on the LHS of the k'th row. Ex: (HIPBLAS_FILL_MODE_LOWER; n = 5; k = 2) 1 0 0 0 0 -> 1 2 3 4 5 6 2 0 0 0 -> 6 7 8 9 0 9 7 3 0 0 -> 9 8 7 0 0 0 8 8 4 0 -> 0 0 0 0 0 0 0 7 9 5 -> 0 0 0 0 0
[in]	lda	- [int] specifies the leading dimension of A. lda must satisfy lda > k.
[in,out]	x	- device pointer storing vector x.
[in]	incx	- [int] specifies the increment for the elements of x.

Member Function/Subroutine Documentation

◆ hipblasstbmv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbmv::hipblasstbmv_	(	type(c_ptr), value	handle,
		integer(kind(hipblas_fill_mode_upper)), value	uplo,
		integer(kind(hipblas_op_n)), value	transa,
		integer(kind(hipblas_diag_non_unit)), value	diag,
		integer(c_int), value	n,
		integer(c_int), value	k,
		type(c_ptr), value	ap,
		integer(c_int), value	lda,
		type(c_ptr), value	x,
		integer(c_int), value	incx
	)

◆ hipblasstbmv_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbmv::hipblasstbmv_full_rank	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(kind(hipblas_op_n))	transa,
		integer(kind(hipblas_diag_non_unit))	diag,
		integer(c_int)	n,
		integer(c_int)	k,
		real(c_float), dimension(:,:), target	ap,
		integer(c_int)	lda,
		real(c_float), dimension(:), target	x,
		integer(c_int)	incx
	)

◆ hipblasstbmv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbmv::hipblasstbmv_rank_0	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(kind(hipblas_op_n))	transa,
		integer(kind(hipblas_diag_non_unit))	diag,
		integer(c_int)	n,
		integer(c_int)	k,
		real(c_float), target	ap,
		integer(c_int)	lda,
		real(c_float), target	x,
		integer(c_int)	incx
	)

◆ hipblasstbmv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasstbmv::hipblasstbmv_rank_1	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(kind(hipblas_op_n))	transa,
		integer(kind(hipblas_diag_non_unit))	diag,
		integer(c_int)	n,
		integer(c_int)	k,
		real(c_float), dimension(:), target	ap,
		integer(c_int)	lda,
		real(c_float), dimension(:), target	x,
		integer(c_int)	incx
	)

---

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

• hipfort_hipblas.F90