hipblascher2batched Interface Reference

hipblascher2batched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblascher2batched Interface Reference
Public Member Functions | List of all members
hipfort_hipblas::hipblascher2batched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblascher2batched_ (handle, uplo, n, alpha, x, incx, y, incy, ap, lda, batchcount)
 

Detailed Description

BLAS Level 2 API.

The her2Batched functions perform the matrix-vector operations: 

A_i := A_i + alpha*x_i*y_i**H + conj(alpha)*y_i*x_i**H

where alpha is a complex scalar, x_i and y_i are vectors, and A_i is an n by n Hermitian matrix for each batch in i = [1, batchCount].

  • Supported precisions in rocBLAS : c and z.
  • Supported precisions in cuBLAS : No support
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]uplo- [hipblasFillMode_t] specifies either upper (HIPBLAS_FILL_MODE_UPPER) or lower (HIPBLAS_FILL_MODE_LOWER):
  • HIPBLAS_FILL_MODE_UPPER: The upper triangular part of each A_i is supplied.
  • HIPBLAS_FILL_MODE_LOWER: The lower triangular part of each A_i is supplied.
[in]n- [int] the number of rows and columns of each matrix A_i. Must be at least 0.
[in]alphadevice pointer or host pointer to scalar alpha.
[in]x- device array of device pointers storing each vector x_i.
[in]incx- [int] specifies the increment for the elements of x.
[in]y- device array of device pointers storing each vector y_i.
[in]incy- [int] specifies the increment for the elements of each y_i.
[in,out]AP- device array of device pointers storing the specified triangular portion of each Hermitian matrix A_i of size (lda, n).
  • if uplo == HIPBLAS_FILL_MODE_UPPER: The upper triangular portion of each Hermitian matrix A_i is supplied. The lower triangular portion of each A_i will not be touched.
  • if uplo == HIPBLAS_FILL_MODE_LOWER: The lower triangular portion of each Hermitian matrix A_i is supplied. The upper triangular portion of each A_i will not be touched.
  • Note that the imaginary parts of the diagonal elements are not accessed and are assumed to be 0.
[in]lda- [int] specifies the leading dimension of each A_i. Must be at least max(lda, 1).
[in]batchCount- [int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblascher2batched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher2batched::hipblascher2batched_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  n,
complex(c_float_complex)  alpha,
type(c_ptr), value  x,
integer(c_int), value  incx,
type(c_ptr), value  y,
integer(c_int), value  incy,
type(c_ptr), value  ap,
integer(c_int), value  lda,
integer(c_int), value  batchcount 
)
The documentation for this interface was generated from the following file: