hipblascher Interface Reference

hipblascher Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblascher Interface Reference
hipfort_hipblas::hipblascher Interface Reference

BLAS Level 2 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblascher_ (handle, uplo, n, alpha, x, incx, ap, lda)
 
integer(kind(hipblas_status_success)) function hipblascher_rank_0 (handle, uplo, n, alpha, x, incx, ap, lda)
 
integer(kind(hipblas_status_success)) function hipblascher_rank_1 (handle, uplo, n, alpha, x, incx, ap, lda)
 
integer(kind(hipblas_status_success)) function hipblascher_full_rank (handle, uplo, n, alpha, x, incx, ap, 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.

  • Supported precisions in rocBLAS : c and z.
  • Supported precisions in cuBLAS : c and z.
Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]uplo- [hipblasFillMode_t] specifies either 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]x- device pointer storing vector x.
[in]incx- [int] specifies the increment for the elements of x.
[in,out]AP- device 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 parts 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

◆ hipblascher_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher::hipblascher_ ( type(c_ptr), value  handle,
integer(kind(hipblas_fill_mode_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  ap,
integer(c_int), value  lda 
)

◆ hipblascher_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher::hipblascher_full_rank ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_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  ap,
integer(c_int)  lda 
)

◆ hipblascher_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher::hipblascher_rank_0 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_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  ap,
integer(c_int)  lda 
)

◆ hipblascher_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher::hipblascher_rank_1 ( type(c_ptr)  handle,
integer(kind(hipblas_fill_mode_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  ap,
integer(c_int)  lda 
)

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