rocsolver_cheevdj_batched Interface Reference

rocsolver_cheevdj_batched Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_cheevdj_batched Interface Reference
hipfort_rocsolver::rocsolver_cheevdj_batched Interface Reference

The HEEVDJ_BATCHED functions computes the eigenvalues and optionally the eigenvectors of a batch of complex Hermitian matrices A_l. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_cheevdj_batched_ (handle, evect, uplo, n, a, lda, d, strided, myinfo, batch_count)
 

Detailed Description

The HEEVDJ_BATCHED functions computes the eigenvalues and optionally the eigenvectors of a batch of complex Hermitian matrices A_l.

The eigenvalues are found using the iterative Jacobi algorithm and are returned in ascending order. The eigenvectors are computed using a divide-and-conquer approach 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 matrices A_l is stored. If uplo indicates lower (or upper), then the upper (or lower) part of A_l is not used.
[in]n- rocblas_int. n >= 0. Number of rows and columns of matrices A_l.
[in,out]A- Array of pointers to type. Each pointer points to an array on the GPU of dimension lda*n. On entry, the matrices A_l. On exit, the eigenvectors of A_l if they were computed and the algorithm converged. Otherwise, the contents of A_l are destroyed.
[in]lda- rocblas_int. lda >= n. Specifies the leading dimension of matrices A_l.
[out]D- pointer to real type. Array on the GPU (the size depends on the value of strideD). The eigenvalues of A_l in increasing order.
[in]strideD- rocblas_stride. Stride from the start of one vector D_l to the next one D_(l+1). There is no restriction for the value of strideD. The normal use case is strideD >= n.
[out]myInfo- pointer to rocblas_int. Array of batch_count integers on the GPU. If info[l] = 0, successful exit for A_l. If info[l] = 1, the algorithm did not converge for A_l.
[in]batch_count- rocblas_int. batch_count >= 0. Number of matrices in the batch.

Member Function/Subroutine Documentation

◆ rocsolver_cheevdj_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cheevdj_batched::rocsolver_cheevdj_batched_ ( 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,
integer(c_int64_t), value  strided,
type(c_ptr), value  myinfo,
integer(c_int), value  batch_count 
)

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