rocblas_srotm Interface Reference

rocblas_srotm Interface Reference#

hipFORT API Reference: hipfort_rocblas::rocblas_srotm Interface Reference
Public Member Functions | List of all members
hipfort_rocblas::rocblas_srotm Interface Reference

BLAS Level 1 API. More...

Public Member Functions

integer(c_int) function rocblas_srotm_ (handle, n, x, incx, y, incy, param)
 
integer(kind(rocblas_status_success)) function rocblas_srotm_rank_0 (handle, n, x, incx, y, incy, param)
 
integer(kind(rocblas_status_success)) function rocblas_srotm_rank_0_devptr (handle, n, x, incx, y, incy, param)
 
integer(kind(rocblas_status_success)) function rocblas_srotm_rank_1 (handle, n, x, incx, y, incy, param)
 
integer(kind(rocblas_status_success)) function rocblas_srotm_rank_1_devptr (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.

Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]n- [rocblas_int] number of elements in the x and y vectors.
[in,out]x- device pointer storing vector x.
[in]incx- [rocblas_int] specifies the increment between elements of x.
[in,out]y- device pointer storing vector y.
[in]incy- [rocblas_int] specifies the increment between elements of y.
[in]param- device vector or host vector of five 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 can be stored in either host or device memory. The location is specified by calling rocblas_set_pointer_mode.

Member Function/Subroutine Documentation

◆ rocblas_srotm_()

integer(c_int) function hipfort_rocblas::rocblas_srotm::rocblas_srotm_ ( 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 
)

◆ rocblas_srotm_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_srotm::rocblas_srotm_rank_0 ( type(c_ptr), value  handle,
integer(c_int)  n,
real(c_float), target  x,
integer(c_int)  incx,
real(c_float), target  y,
integer(c_int)  incy,
real(c_float), target  param 
)

◆ rocblas_srotm_rank_0_devptr()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_srotm::rocblas_srotm_rank_0_devptr ( type(c_ptr), value  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), value  param 
)

◆ rocblas_srotm_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_srotm::rocblas_srotm_rank_1 ( type(c_ptr), value  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,
real(c_float), dimension(:), target  param 
)

◆ rocblas_srotm_rank_1_devptr()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_srotm::rocblas_srotm_rank_1_devptr ( type(c_ptr), value  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), value  param 
)
The documentation for this interface was generated from the following file: