hipblasdrotmg Interface Reference

hipblasdrotmg Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasdrotmg Interface Reference
hipfort_hipblas::hipblasdrotmg Interface Reference

BLAS Level 1 API. More...

Public Member Functions

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

Detailed Description

BLAS Level 1 API.

rotmg creates the modified Givens rotation matrix for the vector (d1 * x1, d2 * y1). 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 pointer or host pointer to input scalar that is overwritten.
[in,out]d2device pointer or host pointer to input scalar that is overwritten.
[in,out]x1device pointer or host pointer to input scalar that is overwritten.
[in]y1device pointer or host pointer to input scalar.
[out]paramdevice vector or host vector 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.

Member Function/Subroutine Documentation

◆ hipblasdrotmg_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasdrotmg::hipblasdrotmg_ ( type(c_ptr), value  handle,
type(c_ptr), value  d1,
type(c_ptr), value  d2,
type(c_ptr), value  x1,
type(c_ptr), value  y1,
type(c_ptr), value  param 
)

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