hipblasdrotmgstridedbatched Interface Reference

hipblasdrotmgstridedbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasdrotmgstridedbatched Interface Reference
hipfort_hipblas::hipblasdrotmgstridedbatched Interface Reference

BLAS Level 1 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasdrotmgstridedbatched_ (handle, d1, stride_d1, d2, stride_d2, x1, stride_x1, y1, stride_y1, param, strideParam, batchCount)
 

Detailed Description

BLAS Level 1 API.

rotmgStridedBatched creates the modified Givens rotation matrix for the strided batched vectors (d1_i * x1_i, d2_i * y1_i), for i = 1, ..., batchCount. Parameters may be stored in either host or device memory, 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.

Parameters
[in]handle[hipblasHandle_t] handle to the hipblas library context queue.
[in,out]d1device strided_batched array or host strided_batched array of input scalars that is overwritten.
[in]stride_d1[hipblasStride] specifies the increment between the beginning of d1_i and d1_(i+1)
[in,out]d2device strided_batched array or host strided_batched array of input scalars that is overwritten.
[in]stride_d2[hipblasStride] specifies the increment between the beginning of d2_i and d2_(i+1)
[in,out]x1device strided_batched array or host strided_batched array of input scalars that is overwritten.
[in]stride_x1[hipblasStride] specifies the increment between the beginning of x1_i and x1_(i+1)
[in]y1device strided_batched array or host strided_batched array of input scalars.
[in]stride_y1[hipblasStride] specifies the increment between the beginning of y1_i and y1_(i+1)
[out]paramdevice stridedBatched array or host stridedBatched array of vectors of 5 elements defining the rotation. 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 ) param may be stored in either host or device memory, location is specified by calling hipblasSetPointerMode.
[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

◆ hipblasdrotmgstridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasdrotmgstridedbatched::hipblasdrotmgstridedbatched_ ( type(c_ptr), value  handle,
type(c_ptr), value  d1,
integer(c_int64_t), value  stride_d1,
type(c_ptr), value  d2,
integer(c_int64_t), value  stride_d2,
type(c_ptr), value  x1,
integer(c_int64_t), value  stride_x1,
type(c_ptr), value  y1,
integer(c_int64_t), value  stride_y1,
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: