rocblas_cher Interface Reference

rocblas_cher Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_cher Interface Reference
Public Member Functions | List of all members
hipfort_rocblas::rocblas_cher Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_cher_ (handle, uplo, n, alpha, x, incx, a, lda)
 
integer(kind(rocblas_status_success)) function rocblas_cher_rank_0 (handle, uplo, n, alpha, x, incx, a, lda)
 
integer(kind(rocblas_status_success)) function rocblas_cher_rank_1 (handle, uplo, n, alpha, x, incx, a, lda)
 
integer(kind(rocblas_status_success)) function rocblas_cher_full_rank (handle, uplo, n, alpha, x, incx, a, lda)
 

Detailed Description

BLAS Level 2 API.

The her functions perform the matrix-vector operations: 

A := A + alpha*x*x**H

where alpha is a real scalar, x is a vector, and A is an n by n Hermitian matrix.

Parameters
[in]handle- [rocblas_handle] handle to the rocBLAS library context queue.
[in]uplo- [rocblas_fill] specifies either upper (rocblas_fill_upper) or lower (rocblas_fill_lower).
  • rocblas_fill_upper: The upper triangular part of A is supplied in A.
  • rocblas_fill_lower: The lower triangular part of A is supplied in A.
[in]n- [rocblas_int] the number of rows and columns of matrix A. Must be at least 0.
[in]alphadevice pointer or host pointer to scalar alpha.
[in]x- device pointer storing vector x.
[in]incx- [rocblas_int] specifies the increment for the elements of x.
[in,out]A- device pointer storing the specified triangular portion of the Hermitian matrix A. Of size (lda * n). 
  if uplo == rocblas_fill_upper:
      The upper triangular portion of the Hermitian matrix A is supplied.
      The lower triangluar portion will not be touched.

  if uplo == rocblas_fill_lower:
      The lower triangular portion of the Hermitian matrix A is supplied.
      The upper triangular portion will not be touched.
Note that the imaginary parts of the diagonal elements are not accessed and are assumed to be 0.
[in]lda- [rocblas_int] specifies the leading dimension of A. Must be at least max(1, n).

Member Function/Subroutine Documentation

◆ rocblas_cher_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cher::rocblas_cher_ ( type(c_ptr), value  handle,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  n,
real(c_float)  alpha,
type(c_ptr), value  x,
integer(c_int), value  incx,
type(c_ptr), value  a,
integer(c_int), value  lda 
)

◆ rocblas_cher_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cher::rocblas_cher_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_float)  alpha,
complex(c_float_complex), dimension(:), target  x,
integer(c_int)  incx,
complex(c_float_complex), dimension(:,:), target  a,
integer(c_int)  lda 
)

◆ rocblas_cher_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cher::rocblas_cher_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_float)  alpha,
complex(c_float_complex), target  x,
integer(c_int)  incx,
complex(c_float_complex), target  a,
integer(c_int)  lda 
)

◆ rocblas_cher_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_cher::rocblas_cher_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
real(c_float)  alpha,
complex(c_float_complex), dimension(:), target  x,
integer(c_int)  incx,
complex(c_float_complex), dimension(:), target  a,
integer(c_int)  lda 
)
The documentation for this interface was generated from the following file: