hipblassrotm Interface Reference

hipblassrotm Interface Reference#

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

BLAS Level 1 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassrotm_ (handle, n, x, incx, y, incy, param)
 
integer(kind(hipblas_status_success)) function hipblassrotm_rank_0 (handle, n, x, incx, y, incy, param)
 
integer(kind(hipblas_status_success)) function hipblassrotm_rank_1 (handle, n, x, incx, y, incy, param)
 

Detailed Description

BLAS Level 1 API.

The rotm functions apply the modified Givens rotation matrix defined by param to vectors x and y.

  • 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]n- [int] number of elements in the x and y vectors.
[in,out]x- device pointer storing vector x.
[in]incx- [int] specifies the increment between elements of x.
[in,out]y- device pointer storing vector y.
[in]incy- [int] specifies the increment between elements of y.
[in]param- device vector or host vector of five elements defining the rotation. param can be stored in either the 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

◆ hipblassrotm_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrotm::hipblassrotm_ ( type(c_ptr), value  handle,
integer(c_int), value  n,
type(c_ptr), value  x,
integer(c_int), value  incx,
type(c_ptr), value  y,
integer(c_int), value  incy,
type(c_ptr), value  param 
)

◆ hipblassrotm_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrotm::hipblassrotm_rank_0 ( type(c_ptr)  handle,
integer(c_int)  n,
real(c_float), target  x,
integer(c_int)  incx,
real(c_float), target  y,
integer(c_int)  incy,
type(c_ptr)  param 
)

◆ hipblassrotm_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrotm::hipblassrotm_rank_1 ( type(c_ptr)  handle,
integer(c_int)  n,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
real(c_float), dimension(:), target  y,
integer(c_int)  incy,
type(c_ptr)  param 
)
The documentation for this interface was generated from the following file: