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

rocblas_zspr_batched Interface Reference

rocblas_zspr_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zspr_batched Interface Reference
hipfort_rocblas::rocblas_zspr_batched Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zspr_batched_ (handle, uplo, n, alpha, x, incx, AP, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zspr_batched_full_rank (handle, uplo, n, alpha, x, incx, AP, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zspr_batched_rank_0 (handle, uplo, n, alpha, x, incx, AP, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zspr_batched_rank_1 (handle, uplo, n, alpha, x, incx, AP, batch_count)
 

Detailed Description

BLAS Level 2 API.

spr_batched performs the matrix-vector operations

A_i := A_i + alpha*x_i*x_i**T

where alpha is a scalar, x_i is a vector, and A_i is an n by n symmetric matrix, supplied in packed form, for 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 in AP. rocblas_fill_lower: The lower triangular part of each A_i is supplied in AP.
[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 each x_i.
[in,out]APdevice array of device pointers storing the packed version of the specified triangular portion of each symmetric matrix A_i of at least size ((n * (n + 1)) 2). Array is of at least size batch_count. if uplo == rocblas_fill_upper: The upper triangular portion of each symmetric 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: (rocblas_fill_upper; n = 4) 1 2 4 7 2 3 5 8 --—> [1, 2, 3, 4, 5, 6, 7, 8, 9, 0] 4 5 6 9 7 8 9 0 if uplo == rocblas_fill_lower: The lower triangular portion of each symmetric 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: (rocblas_fill_lower; n = 4) 1 2 3 4 2 5 6 7 --—> [1, 2, 3, 4, 5, 6, 7, 8, 9, 0] 3 6 8 9 4 7 9 0
[in]batch_count[rocblas_int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_zspr_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zspr_batched::rocblas_zspr_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)  AP,
integer(c_int), value  batch_count 
)

◆ rocblas_zspr_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zspr_batched::rocblas_zspr_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,
type(c_ptr)  AP,
integer(c_int)  batch_count 
)

◆ rocblas_zspr_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zspr_batched::rocblas_zspr_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,
type(c_ptr)  AP,
integer(c_int)  batch_count 
)

◆ rocblas_zspr_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zspr_batched::rocblas_zspr_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,
type(c_ptr)  AP,
integer(c_int)  batch_count 
)

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