rocblas_zherkx Interface Reference

• hipfort_rocblas
• rocblas_zherkx

Public Member Functions | List of all members

hipfort_rocblas::rocblas_zherkx Interface Reference

BLAS Level 3 API. More...

Public Member Functions
integer(kind(rocblas_status_success)) function	rocblas_zherkx_ (handle, uplo, trans, n, k, alpha, A, lda, B, ldb, beta, C, ldc)
integer(kind(rocblas_status_success)) function	rocblas_zherkx_full_rank (handle, uplo, trans, n, k, alpha, A, lda, B, ldb, beta, C, ldc)
integer(kind(rocblas_status_success)) function	rocblas_zherkx_rank_0 (handle, uplo, trans, n, k, alpha, A, lda, B, ldb, beta, C, ldc)
integer(kind(rocblas_status_success)) function	rocblas_zherkx_rank_1 (handle, uplo, trans, n, k, alpha, A, lda, B, ldb, beta, C, ldc)

Detailed Description

BLAS Level 3 API.

herkx performs one of the matrix-matrix operations for a Hermitian rank-k update

C := alpha*op( A )*op( B )^H + beta*C

where alpha and beta are scalars, op(A) and op(B) are n by k matrices, and C 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 ) = A, op( B ) = B, and A and B are n by k if trans == rocblas_operation_none
    op( A ) = A^H, op( B ) = B^H,  and A and B are k by n if trans == rocblas_operation_conjugate_transpose

@param[in]
handle    [rocblas_handle]
          handle to the rocblas library context queue.

@param[in]
uplo    [rocblas_fill]
        rocblas_fill_upper:  C is an upper triangular matrix
        rocblas_fill_lower:  C is a  lower triangular matrix

@param[in]
trans  [rocblas_operation]
        rocblas_operation_conjugate_transpose:  op( A ) = A^H, op( B ) = B^H
        rocblas_operation_none:                 op( A ) = A, op( B ) = B

@param[in]
n       [rocblas_int]
        n specifies the number of rows and columns of C. n >= 0.

@param[in]
k       [rocblas_int]
        k specifies the number of columns of op(A). k >= 0.

@param[in]
alpha
        alpha specifies the scalar alpha. When alpha is
        zero then A is not referenced and A need not be set before
        entry.

@param[in]
A       pointer storing matrix A on the GPU.
        Martrix dimension is ( lda, k ) when if trans = rocblas_operation_none, otherwise (lda, n)
        only the upper/lower triangular part is accessed.

@param[in]
lda     [rocblas_int]
        lda specifies the first dimension of A.
        if trans = rocblas_operation_none,  lda >= max( 1, n ),
        otherwise lda >= max( 1, k ).
@param[in]
B       pointer storing matrix B on the GPU.
        Martrix dimension is ( ldb, k ) when if trans = rocblas_operation_none, otherwise (ldb, n)
        only the upper/lower triangular part is accessed.

@param[in]
ldb     [rocblas_int]
        ldb specifies the first dimension of B.
        if trans = rocblas_operation_none,  ldb >= max( 1, n ),
        otherwise ldb >= max( 1, k ).
@param[in]
beta
        beta specifies the scalar beta. When beta is
        zero then C need not be set before entry.

@param[in]
C       pointer storing matrix C on the GPU.
        The imaginary component of the diagonal elements are not used but are set to zero unless quick return.

@param[in]
ldc    [rocblas_int]
       ldc specifies the first dimension of C. ldc >= max( 1, n ).

Member Function/Subroutine Documentation

◆ rocblas_zherkx_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx::rocblas_zherkx_	(	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,
		type(c_ptr), value	B,
		integer(c_int), value	ldb,
		real(c_double)	beta,
		type(c_ptr), value	C,
		integer(c_int), value	ldc
	)

◆ rocblas_zherkx_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx::rocblas_zherkx_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,
		complex(c_double_complex), dimension(:,:), target	B,
		integer(c_int)	ldb,
		real(c_double)	beta,
		complex(c_double_complex), dimension(:,:), target	C,
		integer(c_int)	ldc
	)

◆ rocblas_zherkx_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx::rocblas_zherkx_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,
		complex(c_double_complex), target	B,
		integer(c_int)	ldb,
		real(c_double)	beta,
		complex(c_double_complex), target	C,
		integer(c_int)	ldc
	)

◆ rocblas_zherkx_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zherkx::rocblas_zherkx_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,
		complex(c_double_complex), dimension(:), target	B,
		integer(c_int)	ldb,
		real(c_double)	beta,
		complex(c_double_complex), dimension(:), target	C,
		integer(c_int)	ldc
	)

---

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

• hipfort_rocblas.f