hipblassrotmg Interface Reference

hipblassrotmg Interface Reference#

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

BLAS Level 1 API. More...

Public Member Functions

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

Detailed Description

BLAS Level 1 API.

The rotmg functions create the modified Givens rotation matrix for the vector (d1 * x1, d2 * y1). 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 : s and d.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in,out]d1- device pointer or host pointer to input scalar that is overwritten.
[in,out]d2- device pointer or host pointer to input scalar that is overwritten.
[in,out]x1- device pointer or host pointer to input scalar that is overwritten.
[in]y1- device pointer or host pointer to input scalar.
[out]param- device vector or host vector 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 )

Member Function/Subroutine Documentation

◆ hipblassrotmg_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrotmg::hipblassrotmg_ ( 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: