rocblas_zsyrk Interface Reference

rocblas_zsyrk Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_zsyrk Interface Reference
hipfort_rocblas::rocblas_zsyrk Interface Reference

BLAS Level 3 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_zsyrk_ (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_zsyrk_full_rank (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_zsyrk_rank_0 (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc)
 
integer(kind(rocblas_status_success)) function rocblas_zsyrk_rank_1 (handle, uplo, transA, n, k, alpha, A, lda, beta, C, ldc)
 

Detailed Description

BLAS Level 3 API.

syrk performs one of the matrix-matrix operations for a symmetric rank-k update

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

where alpha and beta are scalars, op(A) is an n by k matrix, and C is a symmetric n x n matrix stored as either upper or lower.

op( A ) = A, and A is n by k if transA == rocblas_operation_none
op( A ) = A^T and A is k by n if transA == rocblas_operation_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]transA[rocblas_operation] rocblas_operation_transpose: op(A) = A^T rocblas_operation_none: op(A) = A rocblas_operation_conjugate_transpose: op(A) = A^T

rocblas_operation_conjugate_transpose is not supported for complex types, see cherk and zherk.

Parameters
[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]alphaalpha specifies the scalar alpha. When alpha is zero then A is not referenced and A need not be set before entry.
[in]Apointer storing matrix A on the GPU. Martrix dimension is ( lda, k ) when if transA = rocblas_operation_none, otherwise (lda, n) only the upper/lower triangular part is accessed.
[in]lda[rocblas_int] lda specifies the first dimension of A. if transA = rocblas_operation_none, lda >= max( 1, n ), otherwise lda >= max( 1, k ).
[in]betabeta specifies the scalar beta. When beta is zero then C need not be set before entry.
[in]Cpointer storing matrix C on the GPU.
[in]ldc[rocblas_int] ldc specifies the first dimension of C. ldc >= max( 1, n ).

Member Function/Subroutine Documentation

◆ rocblas_zsyrk_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsyrk::rocblas_zsyrk_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(kind(rocblas_operation_none)), value  transA,
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,
complex(c_double_complex)  beta,
type(c_ptr), value  C,
integer(c_int), value  ldc 
)

◆ rocblas_zsyrk_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsyrk::rocblas_zsyrk_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transA,
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)  beta,
complex(c_double_complex), dimension(:,:), target  C,
integer(c_int)  ldc 
)

◆ rocblas_zsyrk_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsyrk::rocblas_zsyrk_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transA,
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)  beta,
complex(c_double_complex), target  C,
integer(c_int)  ldc 
)

◆ rocblas_zsyrk_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_zsyrk::rocblas_zsyrk_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  transA,
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)  beta,
complex(c_double_complex), dimension(:), target  C,
integer(c_int)  ldc 
)

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