hipblascher2 Interface Reference

• hipfort_hipblas
• hipblascher2

Public Member Functions | List of all members

hipfort_hipblas::hipblascher2 Interface Reference

BLAS Level 2 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblascher2_ (handle, uplo, n, alpha, x, incx, y, incy, ap, lda)
integer(kind(hipblas_status_success)) function	hipblascher2_rank_0 (handle, uplo, n, alpha, x, incx, y, incy, ap, lda)
integer(kind(hipblas_status_success)) function	hipblascher2_rank_1 (handle, uplo, n, alpha, x, incx, y, incy, ap, lda)
integer(kind(hipblas_status_success)) function	hipblascher2_full_rank (handle, uplo, n, alpha, x, incx, y, incy, ap, lda)

Detailed Description

BLAS Level 2 API.

The her2 functions perform the matrix-vector operations:

A := A + alpha*x*y**H + conj(alpha)*y*x**H

where alpha is a complex scalar, x and y are vectors, 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. HIPBLAS_FILL_MODE_LOWER: The lower triangular part of A is supplied.
[in]	n	- [int] the number of rows and columns of matrix A. Must be at least 0.
[in]	alpha	device 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]	y	- device pointer storing vector y.
[in]	incy	- [int] specifies the increment for the elements of y.
[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 triangular portion of A 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 of A 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(lda, 1).

Member Function/Subroutine Documentation

◆ hipblascher2_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher2::hipblascher2_	(	type(c_ptr), value	handle,
		integer(kind(hipblas_fill_mode_upper)), value	uplo,
		integer(c_int), value	n,
		complex(c_float_complex)	alpha,
		type(c_ptr), value	x,
		integer(c_int), value	incx,
		type(c_ptr), value	y,
		integer(c_int), value	incy,
		type(c_ptr), value	ap,
		integer(c_int), value	lda
	)

◆ hipblascher2_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher2::hipblascher2_full_rank	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(c_int)	n,
		complex(c_float_complex)	alpha,
		complex(c_float_complex), dimension(:), target	x,
		integer(c_int)	incx,
		complex(c_float_complex), dimension(:), target	y,
		integer(c_int)	incy,
		complex(c_float_complex), dimension(:,:), target	ap,
		integer(c_int)	lda
	)

◆ hipblascher2_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher2::hipblascher2_rank_0	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(c_int)	n,
		complex(c_float_complex)	alpha,
		complex(c_float_complex), target	x,
		integer(c_int)	incx,
		complex(c_float_complex), target	y,
		integer(c_int)	incy,
		complex(c_float_complex), target	ap,
		integer(c_int)	lda
	)

◆ hipblascher2_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblascher2::hipblascher2_rank_1	(	type(c_ptr)	handle,
		integer(kind(hipblas_fill_mode_upper))	uplo,
		integer(c_int)	n,
		complex(c_float_complex)	alpha,
		complex(c_float_complex), dimension(:), target	x,
		integer(c_int)	incx,
		complex(c_float_complex), dimension(:), target	y,
		integer(c_int)	incy,
		complex(c_float_complex), dimension(:), target	ap,
		integer(c_int)	lda
	)

---

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

• hipfort_hipblas.F90