rocsolver_cheev Interface Reference

rocsolver_cheev Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_cheev Interface Reference
Public Member Functions | List of all members
hipfort_rocsolver::rocsolver_cheev Interface Reference

The HEEV functions compute the eigenvalues and optionally the eigenvectors of a Hermitian matrix A. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_cheev_ (handle, evect, uplo, n, a, lda, d, e, myinfo)
 
integer(kind(rocblas_status_success)) function rocsolver_cheev_rank_0 (handle, evect, uplo, n, a, lda, d, e, myinfo)
 
integer(kind(rocblas_status_success)) function rocsolver_cheev_rank_1 (handle, evect, uplo, n, a, lda, d, e, myinfo)
 
integer(kind(rocblas_status_success)) function rocsolver_cheev_full_rank (handle, evect, uplo, n, a, lda, d, e, myinfo)
 

Detailed Description

The HEEV functions compute the eigenvalues and optionally the eigenvectors of a Hermitian matrix A.

Note
The _64 interface accepts int64_t arguments, but the matrix dimensions n and lda must still fit within a 32-bit integer (less than 2^31). The internal tridiagonal reduction and back-transformation steps remain 32-bit, which bounds the supported size.

The eigenvalues are returned in ascending order. The eigenvectors are computed depending on the value of evect. The computed eigenvectors are orthonormal.

Parameters
[in]handle- rocblas_handle.
[in]evect- rocblas_evect. Specifies whether the eigenvectors are to be computed. If evect is rocblas_evect_original, then the eigenvectors are computed. rocblas_evect_tridiagonal is not supported.
[in]uplo- rocblas_fill. Specifies whether the upper or lower part of the Hermitian matrix A is stored. If uplo indicates lower (or upper), then the upper (or lower) part of A is not used.
[in]n- rocblas_int. n >= 0. Number of rows and columns of matrix A.
[in,out]A- pointer to type. Array on the GPU of dimension lda*n. On entry, the matrix A. On exit, the eigenvectors of A if they were computed and the algorithm converged. Otherwise, the contents of A are destroyed.
[in]lda- rocblas_int. lda >= n. Specifies the leading dimension of matrix A.
[out]D- pointer to real type. Array on the GPU of dimension n. The eigenvalues of A in increasing order.
[out]E- pointer to real type. Array on the GPU of dimension n. This array is used to work internally with the tridiagonal matrix T associated with A. On exit, if info > 0, it contains the unconverged off-diagonal elements of T (or properly speaking, a tridiagonal matrix equivalent to T). The diagonal elements of this matrix are in D. Those that converged correspond to a subset of the eigenvalues of A (not necessarily ordered).
[out]myInfo- pointer to a rocblas_int on the GPU. If info = 0, successful exit. If info = i > 0, the algorithm did not converge. i elements of E did not converge to zero.

Member Function/Subroutine Documentation

◆ rocsolver_cheev_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheev::rocsolver_cheev_ ( type(c_ptr), value  handle,
integer(kind(rocblas_evect_original)), value  evect,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(c_int), value  n,
type(c_ptr), value  a,
integer(c_int), value  lda,
type(c_ptr), value  d,
type(c_ptr), value  e,
type(c_ptr), value  myinfo 
)

◆ rocsolver_cheev_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheev::rocsolver_cheev_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_evect_original))  evect,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex), dimension(:,:), target  a,
integer(c_int)  lda,
real(c_float), dimension(:), target  d,
real(c_float), dimension(:), target  e,
type(c_ptr)  myinfo 
)

◆ rocsolver_cheev_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheev::rocsolver_cheev_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_evect_original))  evect,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex), target  a,
integer(c_int)  lda,
real(c_float), target  d,
real(c_float), target  e,
type(c_ptr)  myinfo 
)

◆ rocsolver_cheev_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheev::rocsolver_cheev_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_evect_original))  evect,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex), dimension(:), target  a,
integer(c_int)  lda,
real(c_float), dimension(:), target  d,
real(c_float), dimension(:), target  e,
type(c_ptr)  myinfo 
)
The documentation for this interface was generated from the following file: