hipblasssymm Interface Reference

• hipfort_hipblas
• hipblasssymm

Public Member Functions | List of all members

hipfort_hipblas::hipblasssymm Interface Reference

BLAS Level 3 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblasssymm_ (handle, side, uplo, m, n, alpha, ap, lda, bp, ldb, beta, cp, ldc)
integer(kind(hipblas_status_success)) function	hipblasssymm_rank_0 (handle, side, uplo, m, n, alpha, ap, lda, bp, ldb, beta, cp, ldc)
integer(kind(hipblas_status_success)) function	hipblasssymm_rank_1 (handle, side, uplo, m, n, alpha, ap, lda, bp, ldb, beta, cp, ldc)
integer(kind(hipblas_status_success)) function	hipblasssymm_full_rank (handle, side, uplo, m, n, alpha, ap, lda, bp, ldb, beta, cp, ldc)

Detailed Description

BLAS Level 3 API.

The symm functions perform one of the matrix-matrix operations:

C := alpha*A*B + beta*C if side == HIPBLAS_SIDE_LEFT,
C := alpha*B*A + beta*C if side == HIPBLAS_SIDE_RIGHT,

where alpha and beta are scalars, B and C are m by n matrices, and A is a symmetric matrix stored as either upper or lower.

• Supported precisions in rocBLAS : s, d, c, and z.
• Supported precisions in cuBLAS : s, d, c, and z.

Parameters

[in]	handle	- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]	side	- [hipblasSideMode_t] HIPBLAS_SIDE_LEFT: C := alpha*A*B + beta*C HIPBLAS_SIDE_RIGHT: C := alpha*B*A + beta*C
[in]	uplo	- [hipblasFillMode_t] HIPBLAS_FILL_MODE_UPPER: A is an upper triangular matrix. HIPBLAS_FILL_MODE_LOWER: A is a lower triangular matrix.
[in]	m	- [int] m specifies the number of rows of B and C. m >= 0.
[in]	n	- [int] n specifies the number of columns of B and C. n >= 0.
[in]	alpha	alpha specifies the scalar alpha. When alpha is zero, then A and B are not referenced.
[in]	AP	- pointer storing matrix A on the GPU. A is m by m if side == HIPBLAS_SIDE_LEFT. A is n by n if side == HIPBLAS_SIDE_RIGHT. Only the upper/lower triangular part is accessed.
[in]	lda	- [int] lda specifies the first dimension of A. If side = HIPBLAS_SIDE_LEFT, lda >= max( 1, m ). Otherwise, lda >= max( 1, n ).
[in]	BP	- pointer storing matrix B on the GPU. Matrix dimension is m by n.
[in]	ldb	- [int] ldb specifies the first dimension of B. ldb >= max( 1, m ).
[in]	beta	beta specifies the scalar beta. When beta is zero, then C does not need to be set before entry.
[in]	CP	- pointer storing matrix C on the GPU. Matrix dimension is m by n.
[in]	ldc	- [int] ldc specifies the first dimension of C. ldc >= max( 1, m ).

Member Function/Subroutine Documentation

◆ hipblasssymm_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssymm::hipblasssymm_	(	type(c_ptr), value	handle,
		integer(kind(hipblas_side_left)), value	side,
		integer(kind(hipblas_fill_mode_upper)), value	uplo,
		integer(c_int), value	m,
		integer(c_int), value	n,
		real(c_float)	alpha,
		type(c_ptr), value	ap,
		integer(c_int), value	lda,
		type(c_ptr), value	bp,
		integer(c_int), value	ldb,
		real(c_float)	beta,
		type(c_ptr), value	cp,
		integer(c_int), value	ldc
	)

◆ hipblasssymm_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssymm::hipblasssymm_full_rank	(	type(c_ptr)	handle,
		integer(kind(hipblas_side_left))	side,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(c_int)	m,
		integer(c_int)	n,
		real(c_float)	alpha,
		real(c_float), dimension(:,:), target	ap,
		integer(c_int)	lda,
		real(c_float), dimension(:,:), target	bp,
		integer(c_int)	ldb,
		real(c_float)	beta,
		real(c_float), dimension(:,:), target	cp,
		integer(c_int)	ldc
	)

◆ hipblasssymm_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssymm::hipblasssymm_rank_0	(	type(c_ptr)	handle,
		integer(kind(hipblas_side_left))	side,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(c_int)	m,
		integer(c_int)	n,
		real(c_float)	alpha,
		real(c_float), target	ap,
		integer(c_int)	lda,
		real(c_float), target	bp,
		integer(c_int)	ldb,
		real(c_float)	beta,
		real(c_float), target	cp,
		integer(c_int)	ldc
	)

◆ hipblasssymm_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssymm::hipblasssymm_rank_1	(	type(c_ptr)	handle,
		integer(kind(hipblas_side_left))	side,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(c_int)	m,
		integer(c_int)	n,
		real(c_float)	alpha,
		real(c_float), dimension(:), target	ap,
		integer(c_int)	lda,
		real(c_float), dimension(:), target	bp,
		integer(c_int)	ldb,
		real(c_float)	beta,
		real(c_float), dimension(:), target	cp,
		integer(c_int)	ldc
	)

---

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

• hipfort_hipblas.F90