hipblassgerstridedbatched Interface Reference

hipblassgerstridedbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblassgerstridedbatched Interface Reference
hipfort_hipblas::hipblassgerstridedbatched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassgerstridedbatched_ (handle, m, n, alpha, x, incx, stridex, y, incy, stridey, ap, lda, stridea, batchcount)
 
integer(kind(hipblas_status_success)) function hipblassgerstridedbatched_rank_0 (handle, m, n, alpha, x, incx, stridex, y, incy, stridey, ap, lda, stridea, batchcount)
 
integer(kind(hipblas_status_success)) function hipblassgerstridedbatched_rank_1 (handle, m, n, alpha, x, incx, stridex, y, incy, stridey, ap, lda, stridea, batchcount)
 
integer(kind(hipblas_status_success)) function hipblassgerstridedbatched_full_rank (handle, m, n, alpha, x, incx, stridex, y, incy, stridey, ap, lda, stridea, batchcount)
 

Detailed Description

BLAS Level 2 API.

The gerStridedBatched, geruStridedBatched, and gercStridedBatched functions perform the matrix-vector operations:

A_i := A_i + alpha*x_i*y_i**T, OR
A_i := A_i + alpha*x_i*y_i**H  for gerc

where (A_i, x_i, y_i) is the i-th instance of the batch, alpha is a scalar, x_i and y_i are vectors, and A_i is an m by n matrix, for i = 1, ..., batchCount.

  • Supported precisions in rocBLAS : s, d, c, and z.
  • Supported precisions in cuBLAS : No support.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]m- [int] the number of rows of each matrix A_i.
[in]n- [int] the number of columns of each matrix A_i.
[in]alphadevice pointer or host pointer to scalar alpha.
[in]x- device pointer to the first vector (x_1) in the batch.
[in]incx- [int] specifies the increments for the elements of each vector x_i.
[in]stridex- [hipblasStride] stride from the start of one vector (x_i) to the next one (x_i+1). There are no restrictions placed on stridex. However, the user should ensure that stridex is of an appropriate size. For a typical case, this means stridex >= m * incx.
[in,out]y- device pointer to the first vector (y_1) in the batch.
[in]incy- [int] specifies the increment for the elements of each vector y_i.
[in]stridey- [hipblasStride] stride from the start of one vector (y_i) to the next one (y_i+1). There are no restrictions placed on stridey. However, the user should ensure that stridey is of an appropriate size. For a typical case, this means stridey >= n * incy.
[in,out]AP- device pointer to the first matrix (A_1) in the batch.
[in]lda- [int] specifies the leading dimension of each A_i.
[in]strideA- [hipblasStride] stride from the start of one matrix (A_i) to the next one (A_i+1)
[in]batchCount- [int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblassgerstridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgerstridedbatched::hipblassgerstridedbatched_ ( type(c_ptr), value  handle,
integer(c_int), value  m,
integer(c_int), value  n,
real(c_float)  alpha,
type(c_ptr), value  x,
integer(c_int), value  incx,
integer(c_int64_t), value  stridex,
type(c_ptr), value  y,
integer(c_int), value  incy,
integer(c_int64_t), value  stridey,
type(c_ptr), value  ap,
integer(c_int), value  lda,
integer(c_int64_t), value  stridea,
integer(c_int), value  batchcount 
)

◆ hipblassgerstridedbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgerstridedbatched::hipblassgerstridedbatched_full_rank ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float), dimension(:), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
real(c_float), dimension(:,:), target  ap,
integer(c_int)  lda,
integer(c_int64_t)  stridea,
integer(c_int)  batchcount 
)

◆ hipblassgerstridedbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgerstridedbatched::hipblassgerstridedbatched_rank_0 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
real(c_float), target  ap,
integer(c_int)  lda,
integer(c_int64_t)  stridea,
integer(c_int)  batchcount 
)

◆ hipblassgerstridedbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgerstridedbatched::hipblassgerstridedbatched_rank_1 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
real(c_float)  alpha,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float), dimension(:), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
real(c_float), dimension(:), target  ap,
integer(c_int)  lda,
integer(c_int64_t)  stridea,
integer(c_int)  batchcount 
)

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