hipblasztbmv Interface Reference

• hipfort_hipblas
• hipblasztbmv

Public Member Functions | List of all members

hipfort_hipblas::hipblasztbmv Interface Reference

BLAS Level 2 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblasztbmv_ (handle, uplo, transA, diag, m, k, A, lda, x, incx)
integer(kind(hipblas_status_success)) function	hipblasztbmv_full_rank (handle, uplo, transA, diag, m, k, A, lda, x, incx)
integer(kind(hipblas_status_success)) function	hipblasztbmv_rank_0 (handle, uplo, transA, diag, m, k, A, lda, x, incx)
integer(kind(hipblas_status_success)) function	hipblasztbmv_rank_1 (handle, uplo, transA, diag, m, k, A, lda, x, incx)

Detailed Description

BLAS Level 2 API.

tbmv performs one of the matrix-vector operations

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

x is a vectors and A is a banded m by m matrix (see description below).

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]	trans	[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]	m	[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]	A	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, etc, with the k'th diagonal on the RHS of the 0'th row. Ex: (HIPBLAS_FILL_MODE_UPPER; m = 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; m = 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

◆ hipblasztbmv_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztbmv::hipblasztbmv_	(	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	m,
		integer(c_int), value	k,
		type(c_ptr), value	A,
		integer(c_int), value	lda,
		type(c_ptr), value	x,
		integer(c_int), value	incx
	)

◆ hipblasztbmv_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztbmv::hipblasztbmv_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)	m,
		integer(c_int)	k,
		complex(c_double_complex), dimension(:,:), target	A,
		integer(c_int)	lda,
		complex(c_double_complex), dimension(:), target	x,
		integer(c_int)	incx
	)

◆ hipblasztbmv_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztbmv::hipblasztbmv_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)	m,
		integer(c_int)	k,
		complex(c_double_complex), target	A,
		integer(c_int)	lda,
		complex(c_double_complex), target	x,
		integer(c_int)	incx
	)

◆ hipblasztbmv_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasztbmv::hipblasztbmv_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)	m,
		integer(c_int)	k,
		complex(c_double_complex), dimension(:), target	A,
		integer(c_int)	lda,
		complex(c_double_complex), dimension(:), target	x,
		integer(c_int)	incx
	)

---

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

• hipfort_hipblas.f