hipblaschpr2stridedbatched Interface Reference

hipblaschpr2stridedbatched Interface Reference#

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

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaschpr2stridedbatched_ (handle, uplo, n, alpha, x, incx, stridex, y, incy, stridey, ap, stridea, batchcount)
 
integer(kind(hipblas_status_success)) function hipblaschpr2stridedbatched_rank_0 (handle, uplo, n, alpha, x, incx, stridex, y, incy, stridey, ap, stridea, batchcount)
 
integer(kind(hipblas_status_success)) function hipblaschpr2stridedbatched_rank_1 (handle, uplo, n, alpha, x, incx, stridex, y, incy, stridey, ap, stridea, batchcount)
 

Detailed Description

BLAS Level 2 API.

The hpr2StridedBatched functions perform the matrix-vector operations: 

A_i := A_i + alpha*x_i*y_i**H + conj(alpha)*y_i*x_i**H

where alpha is a complex scalar, x_i and y_i are vectors, and A_i is an n by n symmetric matrix, supplied in packed form, for i = 1, ..., batchCount.

  • Supported precisions in rocBLAS : c and z.
  • Supported precisions in cuBLAS : No support.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]uplo- [hipblasFillMode_t] specifies either upper (HIPBLAS_FILL_MODE_UPPER) or lower (HIPBLAS_FILL_MODE_LOWER):
  • HIPBLAS_FILL_MODE_UPPER: The upper triangular part of each A_i is supplied in AP.
  • HIPBLAS_FILL_MODE_LOWER: The lower triangular part of each A_i is supplied in AP.
[in]n- [int] the number of rows and columns of each matrix A_i. Must be at least 0.
[in]alphadevice pointer or host pointer to scalar alpha.
[in]x- device pointer pointing to the first vector (x_1).
[in]incx- [int] specifies the increment for the elements of each x_i.
[in]stridex- [hipblasStride] stride from the start of one vector (x_i) to the next one (x_i+1).
[in]y- device pointer pointing to the first vector (y_1).
[in]incy- [int] specifies the increment for the elements of each y_i.
[in]stridey- [hipblasStride] stride from the start of one vector (y_i) to the next one (y_i+1).
[in,out]AP- device array of device pointers storing the packed version of the specified triangular portion of each Hermitian matrix A_i. Points to the first matrix (A_1).
  • if uplo == HIPBLAS_FILL_MODE_UPPER: The upper triangular portion of each Hermitian matrix A_i is supplied. The matrix is compacted so that AP contains the triangular portion column-by-column so that: AP(0) = A(0,0) AP(1) = A(0,1) AP(2) = A(1,1), and so forth. Ex: (HIPBLAS_FILL_MODE_UPPER; n = 3) (1, 0) (2, 1) (4,9) (2,-1) (3, 0) (5,3) -> [(1,0), (2,1), (3,0), (4,9), (5,3), (6,0)] (4,-9) (5,-3) (6,0)
  • if uplo == HIPBLAS_FILL_MODE_LOWER: The lower triangular portion of each Hermitian matrix A_i is supplied. The matrix is compacted so that AP contains the triangular portion column-by-column so that: AP(0) = A(0,0) AP(1) = A(1,0) AP(2) = A(2,1), and so forth. Ex: (HIPBLAS_FILL_MODE_LOWER; n = 3) (1, 0) (2, 1) (4,9) (2,-1) (3, 0) (5,3) -> [(1,0), (2,-1), (4,-9), (3,0), (5,-3), (6,0)] (4,-9) (5,-3) (6,0)
  • Note that the imaginary part of the diagonal elements are not accessed and are assumed to be 0.
[in]strideA- [hipblasStride] stride from the start of one (A_i) to the next (A_i+1).
[in]batchCount- [int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblaschpr2stridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaschpr2stridedbatched::hipblaschpr2stridedbatched_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  n,
complex(c_float_complex)  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_int64_t), value  stridea,
integer(c_int), value  batchcount 
)

◆ hipblaschpr2stridedbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaschpr2stridedbatched::hipblaschpr2stridedbatched_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex)  alpha,
complex(c_float_complex), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
complex(c_float_complex), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
complex(c_float_complex), target  ap,
integer(c_int64_t)  stridea,
integer(c_int)  batchcount 
)

◆ hipblaschpr2stridedbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaschpr2stridedbatched::hipblaschpr2stridedbatched_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex)  alpha,
complex(c_float_complex), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
complex(c_float_complex), dimension(:), target  y,
integer(c_int)  incy,
integer(c_int64_t)  stridey,
complex(c_float_complex), dimension(:), target  ap,
integer(c_int64_t)  stridea,
integer(c_int)  batchcount 
)
The documentation for this interface was generated from the following file: