rocblas_drotmg Interface Reference

rocblas_drotmg Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_drotmg Interface Reference
hipfort_rocblas::rocblas_drotmg Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_drotmg_ (handle, d1, d2, x1, y1, param)
 

Detailed Description

!

BLAS Level 1 API

\details
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 rocblas_set_pointer_mode.
      If the pointer mode is set to rocblas_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 rocblas_pointer_mode_device, this function returns immediately and synchronization is required to read the results.

@param[in]
handle  [rocblas_handle]
        handle to the rocblas library context queue.
@param[inout]
d1      device pointer or host pointer to input scalar that is overwritten.
@param[inout]
d2      device pointer or host pointer to input scalar that is overwritten.
@param[inout]
x1      device pointer or host pointer to input scalar that is overwritten.
@param[in]
y1      device pointer or host pointer to input scalar.
@param[out]
param   device 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 rocblas_set_pointer_mode.

Member Function/Subroutine Documentation

◆ rocblas_drotmg_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_drotmg::rocblas_drotmg_ ( 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: