rocblas_cherkx Interface Reference

• hipfort_rocblas
• rocblas_cherkx

Public Member Functions | List of all members

hipfort_rocblas::rocblas_cherkx Interface Reference

BLAS Level 3 API. More...

Public Member Functions
integer(kind(rocblas_status_success)) function	rocblas_cherkx_ (handle, uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
integer(kind(rocblas_status_success)) function	rocblas_cherkx_rank_0 (handle, uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
integer(kind(rocblas_status_success)) function	rocblas_cherkx_rank_1 (handle, uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
integer(kind(rocblas_status_success)) function	rocblas_cherkx_full_rank (handle, uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc)

Detailed Description

BLAS Level 3 API.

The herkx functions perform 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 an 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

Parameters

[in]	handle	- [rocblas_handle] handle to the rocBLAS library context queue.
[in]	uplo	- [rocblas_fill] rocblas_fill_upper: C is an upper triangular matrix. rocblas_fill_lower: C is a lower triangular matrix.
[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
[in]	n	- [rocblas_int] n specifies the number of rows and columns of C. n >= 0.
[in]	k	- [rocblas_int] k specifies the number of columns of op(A). k >= 0.
[in]	alpha	alpha specifies the scalar alpha. When alpha is zero, then A is not referenced and A need not be set before entry.
[in]	A	- pointer storing matrix A on the GPU. Matrix dimension is ( lda, k ) when trans = rocblas_operation_none. Otherwise, (lda, n).
[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 ).
[in]	B	- pointer storing matrix B on the GPU. Matrix dimension is ( ldb, k ) when trans = rocblas_operation_none. Otherwise, (ldb, n).
[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 ).
[in]	beta	beta specifies the scalar beta. When beta is zero, then C need not be set before entry.
[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. Only the upper/lower triangular part is accessed.
[in]	ldc	- [rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, n ).

Member Function/Subroutine Documentation

◆ rocblas_cherkx_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherkx::rocblas_cherkx_	(	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_float_complex)	alpha,
		type(c_ptr), value	a,
		integer(c_int), value	lda,
		type(c_ptr), value	b,
		integer(c_int), value	ldb,
		real(c_float)	beta,
		type(c_ptr), value	c,
		integer(c_int), value	ldc
	)

◆ rocblas_cherkx_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherkx::rocblas_cherkx_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_float_complex)	alpha,
		complex(c_float_complex), dimension(:,:), target	a,
		integer(c_int)	lda,
		complex(c_float_complex), dimension(:,:), target	b,
		integer(c_int)	ldb,
		real(c_float)	beta,
		complex(c_float_complex), dimension(:,:), target	c,
		integer(c_int)	ldc
	)

◆ rocblas_cherkx_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherkx::rocblas_cherkx_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_float_complex)	alpha,
		complex(c_float_complex), target	a,
		integer(c_int)	lda,
		complex(c_float_complex), target	b,
		integer(c_int)	ldb,
		real(c_float)	beta,
		complex(c_float_complex), target	c,
		integer(c_int)	ldc
	)

◆ rocblas_cherkx_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cherkx::rocblas_cherkx_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_float_complex)	alpha,
		complex(c_float_complex), dimension(:), target	a,
		integer(c_int)	lda,
		complex(c_float_complex), dimension(:), target	b,
		integer(c_int)	ldb,
		real(c_float)	beta,
		complex(c_float_complex), dimension(:), target	c,
		integer(c_int)	ldc
	)

---

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

• hipfort_rocblas.F90