rocblas_ssyrkx_strided_batched Interface Reference

rocblas_ssyrkx_strided_batched Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_ssyrkx_strided_batched Interface Reference
hipfort_rocblas::rocblas_ssyrkx_strided_batched Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_ssyrkx_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_ssyrkx_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_ssyrkx_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)
 
integer(kind(rocblas_status_success)) function rocblas_ssyrkx_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)
 

Detailed Description

BLAS Level 3 API.

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

C_i := alpha*op( A_i )*op( B_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 x n matrix stored as either upper or lower.

This routine should only be used when the caller can guarantee that the result of op( A_i )*op( B_i )^T will be symmetric.

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^T, op( B_i ) = B_i^T, and A_i and B_i are k by n if trans ==
rocblas_operation_transpose
or for ssyrkx_strided_batched and dsyrkx_strided_batched when 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_transpose: op( A_i ) = A_i^T, op( B_i ) = B_i^T
  • rocblas_operation_none: op( A_i ) = A_i, op( B_i ) = B_i
  • rocblas_operation_conjugate_transpose: op( A_i ) = A_i^T, op( B_i ) = B_i^T
  • rocblas_operation_conjugate_transpose is not supported for complex types in csyrkx_strided_batched and zsyrkx_strided_batched.
[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, A is not referenced and A need not be set before entry.
[in]A- Device 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) to the next one (A_i+1).
[in]B- Device 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) to the next one (B_i+1).
[in]betabeta specifies the scalar beta. When beta is zero, C need not be set before entry.
[in]C- Device pointer to the first matrix C_1 on the GPU. Only the upper/lower triangular part of each C_i is accessed.
[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) to the next one (C_i+1).
[in]batch_count- [rocblas_int] number of instances in the batch.

Member Function/Subroutine Documentation

◆ rocblas_ssyrkx_strided_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssyrkx_strided_batched::rocblas_ssyrkx_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,
real(c_float)  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_float)  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_ssyrkx_strided_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssyrkx_strided_batched::rocblas_ssyrkx_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,
real(c_float)  alpha,
real(c_float), dimension(:,:), target  a,
integer(c_int)  lda,
integer(c_int64_t)  stride_a,
real(c_float), dimension(:,:), target  b,
integer(c_int)  ldb,
integer(c_int64_t)  stride_b,
real(c_float)  beta,
real(c_float), dimension(:,:), target  c,
integer(c_int)  ldc,
integer(c_int64_t)  stride_c,
integer(c_int)  batch_count 
)

◆ rocblas_ssyrkx_strided_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssyrkx_strided_batched::rocblas_ssyrkx_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,
real(c_float)  alpha,
real(c_float), target  a,
integer(c_int)  lda,
integer(c_int64_t)  stride_a,
real(c_float), target  b,
integer(c_int)  ldb,
integer(c_int64_t)  stride_b,
real(c_float)  beta,
real(c_float), target  c,
integer(c_int)  ldc,
integer(c_int64_t)  stride_c,
integer(c_int)  batch_count 
)

◆ rocblas_ssyrkx_strided_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_ssyrkx_strided_batched::rocblas_ssyrkx_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,
real(c_float)  alpha,
real(c_float), dimension(:), target  a,
integer(c_int)  lda,
integer(c_int64_t)  stride_a,
real(c_float), dimension(:), target  b,
integer(c_int)  ldb,
integer(c_int64_t)  stride_b,
real(c_float)  beta,
real(c_float), 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: