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

rocblas_zher2_batched Interface Reference

rocblas_zher2_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zher2_batched Interface Reference
hipfort_rocblas::rocblas_zher2_batched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zher2_batched_ (handle, uplo, n, alpha, x, incx, y, incy, A, lda, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zher2_batched_full_rank (handle, uplo, n, alpha, x, incx, y, incy, A, lda, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zher2_batched_rank_0 (handle, uplo, n, alpha, x, incx, y, incy, A, lda, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zher2_batched_rank_1 (handle, uplo, n, alpha, x, incx, y, incy, A, lda, batch_count)
 

Detailed Description

BLAS Level 2 API.

her2_batched performs 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, batch_count].

Parameters
[in]handle[rocblas_handle] handle to the rocblas library context queue.
[in]uplo[rocblas_fill] specifies whether the upper 'rocblas_fill_upper' or lower 'rocblas_fill_lower' rocblas_fill_upper: The upper triangular part of each A_i is supplied. rocblas_fill_lower: The lower triangular part of each A_i is supplied.
[in]n[rocblas_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]xdevice array of device pointers storing each vector x_i.
[in]incx[rocblas_int] specifies the increment for the elements of x.
[in]ydevice array of device pointers storing each vector y_i.
[in]incy[rocblas_int] specifies the increment for the elements of each y_i.
[in,out]Adevice array of device pointers storing the specified triangular portion of each Hermitian matrix A_i of size (lda, n). if uplo == rocblas_fill_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 == rocblas_fill_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 part of the diagonal elements are not accessed and are assumed to be 0.
[in]lda[rocblas_int] specifies the leading dimension of each A_i. Must be at least max(lda, 1).
[in]batch_count[rocblas_int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_zher2_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zher2_batched::rocblas_zher2_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  n,
complex(c_double_complex)  alpha,
type(c_ptr)  x,
integer(c_int), value  incx,
type(c_ptr)  y,
integer(c_int), value  incy,
type(c_ptr)  A,
integer(c_int), value  lda,
integer(c_int), value  batch_count 
)

◆ rocblas_zher2_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zher2_batched::rocblas_zher2_batched_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:,:), target  x,
integer(c_int)  incx,
complex(c_double_complex), dimension(:,:), target  y,
integer(c_int)  incy,
complex(c_double_complex), dimension(:,:,:), target  A,
integer(c_int)  lda,
integer(c_int)  batch_count 
)

◆ rocblas_zher2_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zher2_batched::rocblas_zher2_batched_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_double_complex)  alpha,
complex(c_double_complex), target  x,
integer(c_int)  incx,
complex(c_double_complex), target  y,
integer(c_int)  incy,
complex(c_double_complex), target  A,
integer(c_int)  lda,
integer(c_int)  batch_count 
)

◆ rocblas_zher2_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zher2_batched::rocblas_zher2_batched_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx,
complex(c_double_complex), dimension(:), target  y,
integer(c_int)  incy,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
integer(c_int)  batch_count 
)

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