hipblasrotex Interface Reference

hipblasrotex Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasrotex Interface Reference
hipfort_hipblas::hipblasrotex Interface Reference

BLAS EX API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasrotex_ (handle, n, x, xtype, incx, y, ytype, incy, c, s, cstype, executiontype)
 

Detailed Description

BLAS EX API.

The rotEx functions applies 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 the host or device memory. The location is specified by calling hipblasSetPointerMode.

If cs_type is real:

x := c * x + s * y
y := c * y - s * x

If cs_type is complex, the imaginary part of c is ignored:

x := real(c) * x + s * y
y := real(c) * y - conj(s) * x

The supported types are determined by the backend. See the rocBLAS or cuBLAS documentation.

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]xType[hipDataType] specifies the datatype of vector x.
[in]incx- [int] specifies the increment between elements of x.
[in,out]y- device pointer storing vector y.
[in]yType[hipDataType] specifies the datatype of vector y.
[in]incy- [int] specifies the increment between elements of y.
[in]c- device pointer or host pointer storing scalar cosine component of the rotation matrix.
[in]s- device pointer or host pointer storing scalar sine component of the rotation matrix.
[in]csType[hipDataType] specifies the datatype of c and s.
[in]executionType[hipDataType] specifies the datatype of computation.

Member Function/Subroutine Documentation

◆ hipblasrotex_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasrotex::hipblasrotex_ ( type(c_ptr), value  handle,
integer(c_int), value  n,
type(c_ptr), value  x,
integer(kind(hip_r_32f)), value  xtype,
integer(c_int), value  incx,
type(c_ptr), value  y,
integer(kind(hip_r_32f)), value  ytype,
integer(c_int), value  incy,
type(c_ptr), value  c,
type(c_ptr), value  s,
integer(kind(hip_r_32f)), value  cstype,
integer(kind(hip_r_32f)), value  executiontype 
)

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