hipblasrotstridedbatchedex Interface Reference

hipblasrotstridedbatchedex Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasrotstridedbatchedex Interface Reference
hipfort_hipblas::hipblasrotstridedbatchedex Interface Reference

BLAS EX API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasrotstridedbatchedex_ (handle, n, x, xtype, incx, stridex, y, ytype, incy, stridey, c, s, cstype, batchcount, executiontype)
 

Detailed Description

BLAS EX API.

The rotStridedBatchedEx functions apply the Givens rotation matrix defined by c=cos(alpha) and s=sin(alpha) to strided batched vectors x_i and y_i, for i = 1, ..., batchCount. Scalars c and s can be stored in either 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 each x_i and y_i vectors.
[in,out]x- device pointer to the first vector x_1.
[in]xType[hipDataType] specifies the datatype of each vector x_i.
[in]incx- [int] specifies the increment between elements of each x_i.
[in]stridex- [hipblasStride] specifies the increment from the beginning of x_i to the beginning of x_(i+1).
[in,out]y- device pointer to the first vector y_1.
[in]yType[hipDataType] specifies the datatype of each vector y_i.
[in]incy- [int] specifies the increment between elements of each y_i.
[in]stridey- [hipblasStride] specifies the increment from the beginning of y_i to the beginning of y_(i+1).
[in]c- device pointer or host pointer to scalar cosine component of the rotation matrix.
[in]s- device pointer or host pointer to scalar sine component of the rotation matrix.
[in]csType[hipDataType] specifies the datatype of c and s.
[in]batchCount- [int] the number of x and y arrays, that is, the number of batches.
[in]executionType[hipDataType] specifies the datatype of computation.

Member Function/Subroutine Documentation

◆ hipblasrotstridedbatchedex_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasrotstridedbatchedex::hipblasrotstridedbatchedex_ ( 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,
integer(c_int64_t), value  stridex,
type(c_ptr), value  y,
integer(kind(hip_r_32f)), value  ytype,
integer(c_int), value  incy,
integer(c_int64_t), value  stridey,
type(c_ptr), value  c,
type(c_ptr), value  s,
integer(kind(hip_r_32f)), value  cstype,
integer(c_int), value  batchcount,
integer(kind(hip_r_32f)), value  executiontype 
)

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