hipblasssyr2kstridedbatched Interface Reference

hipblasssyr2kstridedbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasssyr2kstridedbatched Interface Reference

BLAS Level 3 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblasssyr2kstridedbatched_ (handle, uplo, transa, n, k, alpha, ap, lda, stridea, bp, ldb, strideb, beta, cp, ldc, stridec, batchcount)

integer(kind(hipblas_status_success)) function	hipblasssyr2kstridedbatched_rank_0 (handle, uplo, transa, n, k, alpha, ap, lda, stridea, bp, ldb, strideb, beta, cp, ldc, stridec, batchcount)

integer(kind(hipblas_status_success)) function	hipblasssyr2kstridedbatched_rank_1 (handle, uplo, transa, n, k, alpha, ap, lda, stridea, bp, ldb, strideb, beta, cp, ldc, stridec, batchcount)

integer(kind(hipblas_status_success)) function	hipblasssyr2kstridedbatched_full_rank (handle, uplo, transa, n, k, alpha, ap, lda, stridea, bp, ldb, strideb, beta, cp, ldc, stridec, batchcount)

Detailed Description

BLAS Level 3 API.

The syr2kStridedBatched functions perform a batch of the matrix-matrix operations for a symmetric rank-2k update:

C_i := alpha*(op( A_i )*op( B_i )^T + op( B_i )*op( A_i )^T) + 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 symmetric n by n matrix stored as either upper or lower.

op( A_i ) = A_i, op( B_i ) = B_i, and A_i and B_i are n by k if trans == HIPBLAS_OP_N
op( A_i ) = A_i^T, op( B_i ) = B_i^T, and A_i and B_i are k by n if trans ==
HIPBLAS_OP_T

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

Parameters

[in]	handle	- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]	uplo	- [hipblasFillMode_t] HIPBLAS_FILL_MODE_UPPER: C_i is an upper triangular matrix. HIPBLAS_FILL_MODE_LOWER: C_i is a lower triangular matrix.
[in]	transA	- [hipblasOperation_t] HIPBLAS_OP_T: op( A_i ) = A_i^T, op( B_i ) = B_i^T HIPBLAS_OP_N: op( A_i ) = A_i, op( B_i ) = B_i
[in]	n	- [int] n specifies the number of rows and columns of C_i. n >= 0.
[in]	k	- [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 does not need to be set before entry.
[in]	AP	- Device pointer to the first matrix A_1 on the GPU of dimension (lda, k) when trans is HIPBLAS_OP_N. Otherwise, of dimension (lda, n).
[in]	lda	- [int] lda specifies the first dimension of A_i. If trans = HIPBLAS_OP_N, lda >= max( 1, n ). Otherwise, lda >= max( 1, k ).
[in]	strideA	- [hipblasStride] stride from the start of one matrix (A_i) to the next one (A_i+1).
[in]	BP	- Device pointer to the first matrix B_1 on the GPU of dimension (ldb, k) when trans is HIPBLAS_OP_N. Otherwise, of dimension (ldb, n).
[in]	ldb	- [int] ldb specifies the first dimension of B_i. If trans = HIPBLAS_OP_N, ldb >= max( 1, n ). Otherwise, ldb >= max( 1, k ).
[in]	strideB	- [hipblasStride] stride from the start of one matrix (B_i) to the next one (B_i+1).
[in]	beta	beta specifies the scalar beta. When beta is zero, then C does not need to be set before entry.
[in]	CP	- Device pointer to the first matrix C_1 on the GPU.
[in]	ldc	- [int] ldc specifies the first dimension of C. ldc >= max( 1, n ).
[in,out]	strideC	- [hipblasStride] stride from the start of one matrix (C_i) to the next one (C_i+1).
[in]	batchCount	- [int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ hipblasssyr2kstridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssyr2kstridedbatched::hipblasssyr2kstridedbatched_	(	type(c_ptr), value	handle,
		integer(kind(hipblas_fill_mode_upper)), value	uplo,
		integer(kind(hipblas_op_n)), value	transa,
		integer(c_int), value	n,
		integer(c_int), value	k,
		real(c_float)	alpha,
		type(c_ptr), value	ap,
		integer(c_int), value	lda,
		integer(c_int64_t), value	stridea,
		type(c_ptr), value	bp,
		integer(c_int), value	ldb,
		integer(c_int64_t), value	strideb,
		real(c_float)	beta,
		type(c_ptr), value	cp,
		integer(c_int), value	ldc,
		integer(c_int64_t), value	stridec,
		integer(c_int), value	batchcount
	)

◆ hipblasssyr2kstridedbatched_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssyr2kstridedbatched::hipblasssyr2kstridedbatched_full_rank	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(kind(hipblas_op_n))	transa,
		integer(c_int)	n,
		integer(c_int)	k,
		real(c_float)	alpha,
		real(c_float), dimension(:,:), target	ap,
		integer(c_int)	lda,
		integer(c_int64_t)	stridea,
		real(c_float), dimension(:,:), target	bp,
		integer(c_int)	ldb,
		integer(c_int64_t)	strideb,
		real(c_float)	beta,
		real(c_float), dimension(:,:), target	cp,
		integer(c_int)	ldc,
		integer(c_int64_t)	stridec,
		integer(c_int)	batchcount
	)

◆ hipblasssyr2kstridedbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssyr2kstridedbatched::hipblasssyr2kstridedbatched_rank_0	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(kind(hipblas_op_n))	transa,
		integer(c_int)	n,
		integer(c_int)	k,
		real(c_float)	alpha,
		real(c_float), target	ap,
		integer(c_int)	lda,
		integer(c_int64_t)	stridea,
		real(c_float), target	bp,
		integer(c_int)	ldb,
		integer(c_int64_t)	strideb,
		real(c_float)	beta,
		real(c_float), target	cp,
		integer(c_int)	ldc,
		integer(c_int64_t)	stridec,
		integer(c_int)	batchcount
	)

◆ hipblasssyr2kstridedbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasssyr2kstridedbatched::hipblasssyr2kstridedbatched_rank_1	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(kind(hipblas_op_n))	transa,
		integer(c_int)	n,
		integer(c_int)	k,
		real(c_float)	alpha,
		real(c_float), dimension(:), target	ap,
		integer(c_int)	lda,
		integer(c_int64_t)	stridea,
		real(c_float), dimension(:), target	bp,
		integer(c_int)	ldb,
		integer(c_int64_t)	strideb,
		real(c_float)	beta,
		real(c_float), dimension(:), target	cp,
		integer(c_int)	ldc,
		integer(c_int64_t)	stridec,
		integer(c_int)	batchcount
	)

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

hipfort_hipblas.F90