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

hipblaszhprbatched Interface Reference

hipblaszhprbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszhprbatched Interface Reference
hipfort_hipblas::hipblaszhprbatched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszhprbatched_ (handle, uplo, n, alpha, x, incx, AP, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszhprbatched_full_rank (handle, uplo, n, alpha, x, incx, AP, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszhprbatched_rank_0 (handle, uplo, n, alpha, x, incx, AP, batchCount)
 
integer(kind(hipblas_status_success)) function hipblaszhprbatched_rank_1 (handle, uplo, n, alpha, x, incx, AP, batchCount)
 

Detailed Description

BLAS Level 2 API.

hprBatched performs the matrix-vector operations

A_i := A_i + alpha*x_i*x_i**H

where alpha is a real scalar, x_i is a vector, and A_i is an n by n symmetric matrix, supplied in packed form, for i = 1, ..., batchCount.

Parameters
[in]handle[hipblasHandle_t] handle to the hipblas library context queue.
[in]uplo[hipblasFillMode_t] specifies whether the 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 in AP. HIPBLAS_FILL_MODE_LOWER: The lower triangular part of each A_i is supplied in AP.
[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]xdevice array of device pointers storing each vector x_i.
[in]incx[int] specifies the increment for the elements of each x_i.
[in,out]APdevice array of device pointers storing the packed version of the specified triangular portion of each Hermitian matrix A_i of at least size ((n * (n + 1)) 2). Array is of at least size batchCount. if uplo == HIPBLAS_FILL_MODE_UPPER: The upper triangular portion of each Hermitian matrix A_i is supplied. The matrix is compacted so that AP contains the triangular portion column-by-column so that: AP(0) = A(0,0) AP(1) = A(0,1) AP(2) = A(1,1), etc. Ex: (HIPBLAS_FILL_MODE_UPPER; n = 3) (1, 0) (2, 1) (4,9) (2,-1) (3, 0) (5,3) --—> [(1,0), (2,1), (3,0), (4,9), (5,3), (6,0)] (4,-9) (5,-3) (6,0) if uplo == HIPBLAS_FILL_MODE_LOWER: The lower triangular portion of each Hermitian matrix A_i is supplied. The matrix is compacted so that AP contains the triangular portion column-by-column so that: AP(0) = A(0,0) AP(1) = A(1,0) AP(2) = A(2,1), etc. Ex: (HIPBLAS_FILL_MODE_LOWER; n = 3) (1, 0) (2, 1) (4,9) (2,-1) (3, 0) (5,3) --—> [(1,0), (2,-1), (4,-9), (3,0), (5,-3), (6,0)] (4,-9) (5,-3) (6,0) Note that the imaginary part of the diagonal elements are not accessed and are assumed to be 0.
[in]batchCount[int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblaszhprbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhprbatched::hipblaszhprbatched_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  n,
real(c_double)  alpha,
type(c_ptr)  x,
integer(c_int), value  incx,
type(c_ptr)  AP,
integer(c_int), value  batchCount 
)

◆ hipblaszhprbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhprbatched::hipblaszhprbatched_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), dimension(:,:), target  x,
integer(c_int)  incx,
type(c_ptr)  AP,
integer(c_int)  batchCount 
)

◆ hipblaszhprbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhprbatched::hipblaszhprbatched_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), target  x,
integer(c_int)  incx,
type(c_ptr)  AP,
integer(c_int)  batchCount 
)

◆ hipblaszhprbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszhprbatched::hipblaszhprbatched_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx,
type(c_ptr)  AP,
integer(c_int)  batchCount 
)

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