This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipblasdrotmgbatched Interface Reference

hipblasdrotmgbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasdrotmgbatched Interface Reference
hipfort_hipblas::hipblasdrotmgbatched Interface Reference

BLAS Level 1 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasdrotmgbatched_ (handle, d1, d2, x1, y1, param, batchCount)
 

Detailed Description

BLAS Level 1 API.

rotmgBatched creates the modified Givens rotation matrix for the 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 batched array or host batched array of input scalars that is overwritten.
[in,out]d2device batched array or host batched array of input scalars that is overwritten.
[in,out]x1device batched array or host batched array of input scalars that is overwritten.
[in]y1device batched array or host batched array of input scalars.
[out]paramdevice batched array or host batched 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]batchCount[int] the number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblasdrotmgbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasdrotmgbatched::hipblasdrotmgbatched_ ( type(c_ptr), value  handle,
type(c_ptr)  d1,
type(c_ptr)  d2,
type(c_ptr)  x1,
type(c_ptr)  y1,
type(c_ptr)  param,
integer(c_int), value  batchCount 
)

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