This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

hipblaszrotgstridedbatched Interface Reference

hipblaszrotgstridedbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszrotgstridedbatched Interface Reference
hipfort_hipblas::hipblaszrotgstridedbatched Interface Reference

BLAS Level 1 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszrotgstridedbatched_ (handle, a, stride_a, b, stride_b, c, stride_c, s, stride_s, batchCount)
 

Detailed Description

BLAS Level 1 API.

rotgStridedBatched creates the Givens rotation matrix for the strided batched vectors (a_i b_i), for i = 1, ..., batchCount. a, b, c, and s may be stored in either host or device memory, location is specified by calling hipblasSetPointerMode. If the pointer mode is set to HIPBLAS_POINTER_MODE_HOST, this function blocks the CPU until the GPU has finished and the results are available in host memory. If the pointer mode is set to HIPBLAS_POINTER_MODE_HOST, this function returns immediately and synchronization is required to read the results.

Parameters
[in]handle[hipblasHandle_t] handle to the hipblas library context queue.
[in,out]adevice strided_batched pointer or host strided_batched pointer to first single input vector element a_1, overwritten with r.
[in]stride_a[hipblasStride] distance between elements of a in batch (distance between a_i and a_(i + 1))
[in,out]bdevice strided_batched pointer or host strided_batched pointer to first single input vector element b_1, overwritten with z.
[in]stride_b[hipblasStride] distance between elements of b in batch (distance between b_i and b_(i + 1))
[in,out]cdevice strided_batched pointer or host strided_batched pointer to first cosine element of Givens rotations c_1.
[in]stride_c[hipblasStride] distance between elements of c in batch (distance between c_i and c_(i + 1))
[in,out]sdevice strided_batched pointer or host strided_batched pointer to sine element of Givens rotations s_1.
[in]stride_s[hipblasStride] distance between elements of s in batch (distance between s_i and s_(i + 1))
[in]batchCount[int] number of batches (length of arrays a, b, c, and s).

Member Function/Subroutine Documentation

◆ hipblaszrotgstridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszrotgstridedbatched::hipblaszrotgstridedbatched_ ( type(c_ptr), value  handle,
type(c_ptr), value  a,
integer(c_int64_t), value  stride_a,
type(c_ptr), value  b,
integer(c_int64_t), value  stride_b,
type(c_ptr), value  c,
integer(c_int64_t), value  stride_c,
type(c_ptr), value  s,
integer(c_int64_t), value  stride_s,
integer(c_int), value  batchCount 
)

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