hipblasrotbatchedex Interface Reference

hipblasrotbatchedex Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasrotbatchedex Interface Reference

BLAS EX API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblasrotbatchedex_ (handle, n, x, xtype, incx, y, ytype, incy, c, s, cstype, batchcount, executiontype)

Detailed Description

BLAS EX API.

The rotBatchedEx functions apply the Givens rotation matrix defined by c=cos(alpha) and s=sin(alpha) to batched vectors x_i andy_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 array of device pointers storing each vector x_i.
[in]	xType	[hipDataType] specifies the datatype of each vector x_i.
[in]	incx	- [int] specifies the increment between elements of each x_i.
[in,out]	y	- device array of device pointers storing each vector y_i.
[in]	yType	[hipDataType] specifies the datatype of each vector y_i.
[in]	incy	- [int] specifies the increment between elements of each y_i.
[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