hipblassrot Interface Reference

hipblassrot Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblassrot Interface Reference
hipfort_hipblas::hipblassrot Interface Reference

BLAS Level 1 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassrot_ (handle, n, x, incx, y, incy, c, s)
 
integer(kind(hipblas_status_success)) function hipblassrot_rank_0 (handle, n, x, incx, y, incy, c, s)
 
integer(kind(hipblas_status_success)) function hipblassrot_rank_1 (handle, n, x, incx, y, incy, c, s)
 

Detailed Description

BLAS Level 1 API.

The rot functions apply the Givens rotation matrix defined by c=cos(alpha) and s=sin(alpha) to vectors x and y. Scalars c and s can be stored in either host or device memory. The location is specified by calling hipblasSetPointerMode.

  • Supported precisions in rocBLAS : s, d, c, z, sc, and dz.
  • Supported precisions in cuBLAS : s, d, c, z, cs, and zd.
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]c- device pointer or host pointer storing the scalar cosine component of the rotation matrix.
[in]s- device pointer or host pointer storing the scalar sine component of the rotation matrix.

Member Function/Subroutine Documentation

◆ hipblassrot_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrot::hipblassrot_ ( 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  c,
type(c_ptr), value  s 
)

◆ hipblassrot_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrot::hipblassrot_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)  c,
type(c_ptr)  s 
)

◆ hipblassrot_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassrot::hipblassrot_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)  c,
type(c_ptr)  s 
)

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