hipblassgbmvstridedbatched Interface Reference

hipblassgbmvstridedbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblassgbmvstridedbatched Interface Reference
Public Member Functions | List of all members
hipfort_hipblas::hipblassgbmvstridedbatched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassgbmvstridedbatched_ (handle, trans, m, n, kl, ku, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 
integer(kind(hipblas_status_success)) function hipblassgbmvstridedbatched_rank_0 (handle, trans, m, n, kl, ku, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 
integer(kind(hipblas_status_success)) function hipblassgbmvstridedbatched_rank_1 (handle, trans, m, n, kl, ku, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 
integer(kind(hipblas_status_success)) function hipblassgbmvstridedbatched_full_rank (handle, trans, m, n, kl, ku, alpha, ap, lda, stridea, x, incx, stridex, beta, y, incy, stridey, batchcount)
 

Detailed Description

BLAS Level 2 API.

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

  • 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]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 to first banded matrix (A_1). 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]strideA- [hipblasStride] stride from the start of one matrix (A_i) to the next one (A_i+1).
[in]x- device pointer to first vector (x_1).
[in]incx- [int] specifies the increment for the elements of x.
[in]stridex- [hipblasStride] stride from the start of one vector (x_i) to the next one (x_i+1).
[in]beta- device pointer or host pointer to scalar beta.
[in,out]y- device pointer to first vector (y_1).
[in]incy- [int] specifies the increment for the elements of y.
[in]stridey- [hipblasStride] stride from the start of one vector (y_i) to the next one (x_i+1).
[in]batchCount- [int] specifies the number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblassgbmvstridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmvstridedbatched::hipblassgbmvstridedbatched_ ( 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,
integer(c_int64_t), value  stridea,
type(c_ptr), value  x,
integer(c_int), value  incx,
integer(c_int64_t), value  stridex,
real(c_float)  beta,
type(c_ptr), value  y,
integer(c_int), value  incy,
integer(c_int64_t), value  stridey,
integer(c_int), value  batchcount 
)

◆ hipblassgbmvstridedbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmvstridedbatched::hipblassgbmvstridedbatched_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,
integer(c_int64_t)  stridea,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float)  beta,
real(c_float), dimension(:), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
integer(c_int)  batchcount 
)

◆ hipblassgbmvstridedbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmvstridedbatched::hipblassgbmvstridedbatched_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,
integer(c_int64_t)  stridea,
real(c_float), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float)  beta,
real(c_float), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
integer(c_int)  batchcount 
)

◆ hipblassgbmvstridedbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgbmvstridedbatched::hipblassgbmvstridedbatched_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,
integer(c_int64_t)  stridea,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
real(c_float)  beta,
real(c_float), dimension(:), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
integer(c_int)  batchcount 
)
The documentation for this interface was generated from the following file: