rocblas_zherkx_strided_batched Interface Reference

rocblas_zherkx_strided_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zherkx_strided_batched Interface Reference
hipfort_rocblas::rocblas_zherkx_strided_batched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zherkx_strided_batched_ (handle, uplo, trans, n, k, alpha, A, lda, stride_A, B, ldb, stride_B, beta, C, ldc, stride_C, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zherkx_strided_batched_full_rank (handle, uplo, trans, n, k, alpha, A, lda, stride_A, B, ldb, stride_B, beta, C, ldc, stride_C, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zherkx_strided_batched_rank_0 (handle, uplo, trans, n, k, alpha, A, lda, stride_A, B, ldb, stride_B, beta, C, ldc, stride_C, batch_count)
 
integer(kind(rocblas_status_success)) function rocblas_zherkx_strided_batched_rank_1 (handle, uplo, trans, n, k, alpha, A, lda, stride_A, B, ldb, stride_B, beta, C, ldc, stride_C, batch_count)
 

Detailed Description

BLAS Level 3 API.

herkx_strided_batched performs a batch of the matrix-matrix operations for a Hermitian rank-k update

C_i := alpha*op( A_i )*op( B_i )^H + beta*C_i

where alpha and beta are scalars, op(A_i) and op(B_i) are n by k matrices, and C_i is a n x n Hermitian matrix stored as either upper or lower. This routine should only be used when the caller can guarantee that the result of op( A )*op( B )^T will be Hermitian.

op( A_i ) = A_i, op( B_i ) = B_i, and A_i and B_i are n by k if trans == rocblas_operation_none
op( A_i ) = A_i^H, op( B_i ) = B_i^H,  and A_i and B_i are k by n if trans == rocblas_operation_conjugate_transpose
Parameters
[in]handle[rocblas_handle] handle to the rocblas library context queue.
[in]uplo[rocblas_fill] rocblas_fill_upper: C_i is an upper triangular matrix rocblas_fill_lower: C_i is a lower triangular matrix
[in]trans[rocblas_operation] rocblas_operation_conjugate_transpose: op( A_i ) = A_i^H, op( B_i ) = B_i^H rocblas_operation_none: op( A_i ) = A_i, op( B_i ) = B_i
[in]n[rocblas_int] n specifies the number of rows and columns of C_i. n >= 0.
[in]k[rocblas_int] k specifies the number of columns of op(A). k >= 0.
[in]alphaalpha specifies the scalar alpha. When alpha is zero then A is not referenced and A need not be set before entry.
[in]ADevice pointer to the first matrix A_1 on the GPU of dimension (lda, k) when trans is rocblas_operation_none, otherwise of dimension (lda, n)
[in]lda[rocblas_int] lda specifies the first dimension of A_i. if trans = rocblas_operation_none, lda >= max( 1, n ), otherwise lda >= max( 1, k ).
[in]stride_A[rocblas_stride] stride from the start of one matrix (A_i) and the next one (A_i+1)
[in]BDevice pointer to the first matrix B_1 on the GPU of dimension (ldb, k) when trans is rocblas_operation_none, otherwise of dimension (ldb, n)
[in]ldb[rocblas_int] ldb specifies the first dimension of B_i. if trans = rocblas_operation_none, ldb >= max( 1, n ), otherwise ldb >= max( 1, k ).
[in]stride_B[rocblas_stride] stride from the start of one matrix (B_i) and the next one (B_i+1)
[in]betabeta specifies the scalar beta. When beta is zero then C need not be set before entry.
[in]CDevice pointer to the first matrix C_1 on the GPU. The imaginary component of the diagonal elements are not used but are set to zero unless quick return.
[in]ldc[rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, n ).
[in,out]stride_C[rocblas_stride] stride from the start of one matrix (C_i) and the next one (C_i+1)
[in]batch_count[rocblas_int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_zherkx_strided_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx_strided_batched::rocblas_zherkx_strided_batched_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(kind(rocblas_operation_none)), value  trans,
integer(c_int), value  n,
integer(c_int), value  k,
complex(c_double_complex)  alpha,
type(c_ptr), value  A,
integer(c_int), value  lda,
integer(c_int64_t), value  stride_A,
type(c_ptr), value  B,
integer(c_int), value  ldb,
integer(c_int64_t), value  stride_B,
real(c_double)  beta,
type(c_ptr), value  C,
integer(c_int), value  ldc,
integer(c_int64_t), value  stride_C,
integer(c_int), value  batch_count 
)

◆ rocblas_zherkx_strided_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx_strided_batched::rocblas_zherkx_strided_batched_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  trans,
integer(c_int)  n,
integer(c_int)  k,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:,:), target  A,
integer(c_int)  lda,
integer(c_int64_t)  stride_A,
complex(c_double_complex), dimension(:,:), target  B,
integer(c_int)  ldb,
integer(c_int64_t)  stride_B,
real(c_double)  beta,
complex(c_double_complex), dimension(:,:), target  C,
integer(c_int)  ldc,
integer(c_int64_t)  stride_C,
integer(c_int)  batch_count 
)

◆ rocblas_zherkx_strided_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx_strided_batched::rocblas_zherkx_strided_batched_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  trans,
integer(c_int)  n,
integer(c_int)  k,
complex(c_double_complex)  alpha,
complex(c_double_complex), target  A,
integer(c_int)  lda,
integer(c_int64_t)  stride_A,
complex(c_double_complex), target  B,
integer(c_int)  ldb,
integer(c_int64_t)  stride_B,
real(c_double)  beta,
complex(c_double_complex), target  C,
integer(c_int)  ldc,
integer(c_int64_t)  stride_C,
integer(c_int)  batch_count 
)

◆ rocblas_zherkx_strided_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx_strided_batched::rocblas_zherkx_strided_batched_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  trans,
integer(c_int)  n,
integer(c_int)  k,
complex(c_double_complex)  alpha,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
integer(c_int64_t)  stride_A,
complex(c_double_complex), dimension(:), target  B,
integer(c_int)  ldb,
integer(c_int64_t)  stride_B,
real(c_double)  beta,
complex(c_double_complex), dimension(:), target  C,
integer(c_int)  ldc,
integer(c_int64_t)  stride_C,
integer(c_int)  batch_count 
)

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