hipblaszgbmvbatched Interface Reference

• hipfort_hipblas
• hipblaszgbmvbatched

Public Member Functions | List of all members

hipfort_hipblas::hipblaszgbmvbatched Interface Reference

BLAS Level 2 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblaszgbmvbatched_ (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy, batchCount)
integer(kind(hipblas_status_success)) function	hipblaszgbmvbatched_full_rank (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy, batchCount)
integer(kind(hipblas_status_success)) function	hipblaszgbmvbatched_rank_0 (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy, batchCount)
integer(kind(hipblas_status_success)) function	hipblaszgbmvbatched_rank_1 (handle, trans, m, n, kl, ku, alpha, A, lda, x, incx, beta, y, incy, batchCount)

Detailed Description

BLAS Level 2 API.

gbmvBatched performs one of the matrix-vector operations

y_i := alpha*A_i*x_i    + beta*y_i,   or
y_i := alpha*A_i**T*x_i + beta*y_i,   or
y_i := alpha*A_i**H*x_i + beta*y_i,

where (A_i, x_i, y_i) is the i-th instance of the batch. alpha and beta are scalars, x_i and y_i are vectors and A_i is an m by n banded matrix with kl sub-diagonals and ku super-diagonals, for i = 1, ..., batchCount.

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 each matrix A_i
[in]	n	[int] number of columns of each matrix A_i
[in]	kl	[int] number of sub-diagonals of each A_i
[in]	ku	[int] number of super-diagonals of each A_i
[in]	alpha	device pointer or host pointer to scalar alpha.
[in]	A	device array of device pointers storing each banded matrix A_i. 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 propogates 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 the empty elements which don't correspond to data will not be referenced.
[in]	lda	[int] specifies the leading dimension of each A_i. Must be >= (kl + ku + 1)
[in]	x	device array of device pointers storing each vector x_i.
[in]	incx	[int] specifies the increment for the elements of each x_i.
[in]	beta	device pointer or host pointer to scalar beta.
[in,out]	y	device array of device pointers storing each vector y_i.
[in]	incy	[int] specifies the increment for the elements of each y_i.
[in]	batchCount	[int] specifies the number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblaszgbmvbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmvbatched::hipblaszgbmvbatched_	(	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,
		complex(c_double_complex)	alpha,
		type(c_ptr)	A,
		integer(c_int), value	lda,
		type(c_ptr)	x,
		integer(c_int), value	incx,
		complex(c_double_complex)	beta,
		type(c_ptr)	y,
		integer(c_int), value	incy,
		integer(c_int), value	batchCount
	)

◆ hipblaszgbmvbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmvbatched::hipblaszgbmvbatched_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,
		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,
		integer(c_int)	batchCount
	)

◆ hipblaszgbmvbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmvbatched::hipblaszgbmvbatched_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,
		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,
		integer(c_int)	batchCount
	)

◆ hipblaszgbmvbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgbmvbatched::hipblaszgbmvbatched_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,
		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,
		integer(c_int)	batchCount
	)

---

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

• hipfort_hipblas.f