This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

rocsolver_cheevd Interface Reference

rocsolver_cheevd Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_cheevd Interface Reference
hipfort_rocsolver::rocsolver_cheevd Interface Reference

HEEVD computes the eigenvalues and optionally the eigenvectors of a Hermitian matrix A. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_cheevd_ (handle, evect, uplo, n, A, lda, D, E, myInfo)
 
integer(kind(rocblas_status_success)) function rocsolver_cheevd_full_rank (handle, evect, uplo, n, A, lda, D, E, myInfo)
 
integer(kind(rocblas_status_success)) function rocsolver_cheevd_rank_0 (handle, evect, uplo, n, A, lda, D, E, myInfo)
 
integer(kind(rocblas_status_success)) function rocsolver_cheevd_rank_1 (handle, evect, uplo, n, A, lda, D, E, myInfo)
 

Detailed Description

HEEVD computes the eigenvalues and optionally the eigenvectors of a Hermitian matrix A.

The eigenvalues are returned in ascending order. The eigenvectors are computed using a divide-and-conquer algorithm, depending on the value of evect. The computed eigenvectors are orthonormal.

Parameters
[in]handlerocblas_handle.
[in]evectrocblas_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]uplorocblas_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]nrocblas_int. n >= 0.
Number of rows and columns of matrix A.
[in,out]Apointer 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]ldarocblas_int. lda >= n.
Specifies the leading dimension of matrix A.
[out]Dpointer to real type. Array on the GPU of dimension n.
The eigenvalues of A in increasing order.
[out]Epointer 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]infopointer to a rocblas_int on the GPU.
If info = 0, successful exit. If info = i > 0 and evect is rocblas_evect_none, the algorithm did not converge. i elements of E did not converge to zero. If info = i > 0 and evect is rocblas_evect_original, the algorithm failed to compute an eigenvalue in the submatrix from [i/(n+1), i/(n+1)] to [i%(n+1), i%(n+1)].

Member Function/Subroutine Documentation

◆ rocsolver_cheevd_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheevd::rocsolver_cheevd_ ( 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,
integer(c_int)  myInfo 
)

◆ rocsolver_cheevd_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheevd::rocsolver_cheevd_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,
integer(c_int)  myInfo 
)

◆ rocsolver_cheevd_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheevd::rocsolver_cheevd_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,
integer(c_int)  myInfo 
)

◆ rocsolver_cheevd_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheevd::rocsolver_cheevd_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,
integer(c_int)  myInfo 
)

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