hipblaszher Interface Reference

hipblaszher Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszher Interface Reference
hipfort_hipblas::hipblaszher Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszher_ (handle, uplo, n, alpha, x, incx, A, lda)
 
integer(kind(hipblas_status_success)) function hipblaszher_full_rank (handle, uplo, n, alpha, x, incx, A, lda)
 
integer(kind(hipblas_status_success)) function hipblaszher_rank_0 (handle, uplo, n, alpha, x, incx, A, lda)
 
integer(kind(hipblas_status_success)) function hipblaszher_rank_1 (handle, uplo, n, alpha, x, incx, A, lda)
 

Detailed Description

BLAS Level 2 API.

her performs 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[hipblasHandle_t] handle to the hipblas library context queue.
[in]uplo[hipblasFillMode_t] specifies whether the upper 'HIPBLAS_FILL_MODE_UPPER' or lower 'HIPBLAS_FILL_MODE_LOWER' HIPBLAS_FILL_MODE_UPPER: The upper triangular part of A is supplied in A. HIPBLAS_FILL_MODE_LOWER: The lower triangular part of A is supplied in A.
[in]n[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]xdevice pointer storing vector x.
[in]incx[int] specifies the increment for the elements of x.
[in,out]Adevice pointer storing the specified triangular portion of the Hermitian matrix A. Of size (lda * n). if uplo == HIPBLAS_FILL_MODE_UPPER: The upper triangular portion of the Hermitian matrix A is supplied. The lower triangluar portion will not be touched. if uplo == HIPBLAS_FILL_MODE_LOWER: The lower triangular portion of the Hermitian matrix A is supplied. The upper triangular portion will not be touched. Note that the imaginary part of the diagonal elements are not accessed and are assumed to be 0.
[in]lda[int] specifies the leading dimension of A. Must be at least max(1, n).

Member Function/Subroutine Documentation

◆ hipblaszher_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher::hipblaszher_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_upper)), value  uplo,
integer(c_int), value  n,
real(c_double)  alpha,
type(c_ptr), value  x,
integer(c_int), value  incx,
type(c_ptr), value  A,
integer(c_int), value  lda 
)

◆ hipblaszher_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher::hipblaszher_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx,
complex(c_double_complex), dimension(:,:), target  A,
integer(c_int)  lda 
)

◆ hipblaszher_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher::hipblaszher_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), target  x,
integer(c_int)  incx,
complex(c_double_complex), target  A,
integer(c_int)  lda 
)

◆ hipblaszher_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszher::hipblaszher_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_upper))  uplo,
integer(c_int)  n,
real(c_double)  alpha,
complex(c_double_complex), dimension(:), target  x,
integer(c_int)  incx,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda 
)

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