hipblassrotmgstridedbatched Interface Reference

hipblassrotmgstridedbatched Interface Reference#

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

BLAS Level 1 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassrotmgstridedbatched_ (handle, d1, strided1, d2, strided2, x1, stridex1, y1, stridey1, param, strideparam, batchcount)
 

Detailed Description

BLAS Level 1 API.

The rotmgStridedBatched functions create the modified Givens rotation matrix for the strided batched vectors (d1_i * x1_i, d2_i * y1_i), for i = 1, ..., batchCount. Parameters can be stored in either host or device memory. The location is specified by calling hipblasSetPointerMode. If the pointer mode is set to HIPBLAS_POINTER_MODE_HOST, this function blocks the CPU until the GPU has finished and the results are available in host memory. If the pointer mode is set to HIPBLAS_POINTER_MODE_DEVICE, this function returns immediately and synchronization is required to read the results.

  • Supported precisions in rocBLAS : s and d.
  • Supported precisions in cuBLAS : No support.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in,out]d1- device strided_batched array or host strided_batched array of input scalars that is overwritten.
[in]strided1- [hipblasStride] specifies the increment between the beginning of d1_i and d1_(i+1).
[in,out]d2- device strided_batched array or host strided_batched array of input scalars that is overwritten.
[in]strided2- [hipblasStride] specifies the increment between the beginning of d2_i and d2_(i+1).
[in,out]x1- device strided_batched array or host strided_batched array of input scalars that is overwritten.
[in]stridex1- [hipblasStride] specifies the increment between the beginning of x1_i and x1_(i+1).
[in]y1- device strided_batched array or host strided_batched array of input scalars.
[in]stridey1- [hipblasStride] specifies the increment between the beginning of y1_i and y1_(i+1).
[out]param- device stridedBatched array or host stridedBatched array of vectors of five elements defining the rotation. param can be stored in either host or device memory. The location is specified by calling hipblasSetPointerMode.
  • param[0] = flag
  • param[1] = H11
  • param[2] = H21
  • param[3] = H12
  • param[4] = H22 The flag parameter defines the form of H:
  • flag = -1 => H = ( H11 H12 H21 H22 )
  • flag = 0 => H = ( 1.0 H12 H21 1.0 )
  • flag = 1 => H = ( H11 1.0 -1.0 H22 )
  • flag = -2 => H = ( 1.0 0.0 0.0 1.0 )
[in]strideParam- [hipblasStride] specifies the increment between the beginning of param_i and param_(i + 1).
[in]batchCount- [int] the number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblassrotmgstridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrotmgstridedbatched::hipblassrotmgstridedbatched_ ( type(c_ptr), value  handle,
type(c_ptr), value  d1,
integer(c_int64_t), value  strided1,
type(c_ptr), value  d2,
integer(c_int64_t), value  strided2,
type(c_ptr), value  x1,
integer(c_int64_t), value  stridex1,
type(c_ptr), value  y1,
integer(c_int64_t), value  stridey1,
type(c_ptr), value  param,
integer(c_int64_t), value  strideparam,
integer(c_int), value  batchcount 
)
The documentation for this interface was generated from the following file: