rocsolver_chegst_strided_batched Interface Reference

rocsolver_chegst_strided_batched Interface Reference#

hipFORT API Reference: hipfort_rocsolver::rocsolver_chegst_strided_batched Interface Reference
hipfort_rocsolver::rocsolver_chegst_strided_batched Interface Reference

The HEGST_STRIDED_BATCHED functions reduce a batch of Hermitian-definite generalized eigenproblems to standard form. More...

Public Member Functions

integer(c_int) function rocsolver_chegst_strided_batched_ (handle, itype, uplo, n, a, lda, stridea, b, ldb, strideb, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_chegst_strided_batched_rank_0 (handle, itype, uplo, n, a, lda, stridea, b, ldb, strideb, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_chegst_strided_batched_rank_1 (handle, itype, uplo, n, a, lda, stridea, b, ldb, strideb, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_chegst_strided_batched_full_rank (handle, itype, uplo, n, a, lda, stridea, b, ldb, strideb, batch_count)
 

Detailed Description

The HEGST_STRIDED_BATCHED functions reduce a batch of Hermitian-definite generalized eigenproblems to standard form.

(This is the blocked version of the algorithm.)

For each instance in the batch, the problem solved by this function is either of the form

\[ \begin{array}{cl} A_l X_l = \lambda B_l X_l & \: \text{1st form,}\\% A_l B_l X_l = \lambda X_l & \: \text{2nd form, or}\\% B_l A_l X_l = \lambda X_l & \: \text{3rd form,} \end{array} \]

depending on the value of itype.

If the problem is of the first form, then \(A_l\) is overwritten with

\[ \begin{array}{cl} U_l^{-H} A_l^{} U_l^{-1}, & \: \text{or}\\% L_l^{-1} A_l^{} L_l^{-H}, \end{array} \]

where the Hermitian-definite matrix \(B_l\) has been factorized as either \(U_l^H U_l^{}\) or \(L_l^{} L_l^H\), as returned by POTRF, depending on the value of uplo.

If the problem is of the second or third form, then A is overwritten with

\[ \begin{array}{cl} U_l^{} A_l^{} U_l^H, & \: \text{or}\\% L_l^H A_l^{} L_l^{}, \end{array} \]

also depending on the value of uplo.

Parameters
[in]handle- rocblas_handle.
[in]itype- rocblas_eform. Specifies the form of the generalized eigenproblems.
[in]uplo- rocblas_fill. Specifies whether the upper or lower part of the matrices A_l are stored, and whether the factorization applied to B_l was upper or lower triangular. If uplo indicates lower (or upper), then the upper (or lower) parts of A_l and B_l are not used.
[in]n- rocblas_int. n >= 0. The matrix dimensions.
[in,out]A- pointer to type. Array on the GPU (the size depends on the value of strideA). On entry, the matrices A_l. On exit, the transformed matrices associated with the equivalent standard eigenvalue problems.
[in]lda- rocblas_int. lda >= n. Specifies the leading dimension of A_l.
[in]strideA- rocblas_stride. Stride from the start of one matrix A_l to the next one A_(l+1). There is no restriction for the value of strideA. The normal use case is strideA >= lda*n.
[out]B- pointer to type. Array on the GPU (the size depends on the value of strideB). The triangular factors of the matrices B_l, as returned by POTRF_STRIDED_BATCHED.
[in]ldb- rocblas_int. ldb >= n. Specifies the leading dimension of B_l.
[in]strideB- rocblas_stride. Stride from the start of one matrix B_l to the next one B_(l+1). There is no restriction for the value of strideB. The normal use case is strideB >= ldb*n.
[in]batch_count- rocblas_int. batch_count >= 0. Number of matrices in the batch.

Member Function/Subroutine Documentation

◆ rocsolver_chegst_strided_batched_()

integer(c_int) function hipfort_rocsolver::rocsolver_chegst_strided_batched::rocsolver_chegst_strided_batched_ ( type(c_ptr), value  handle,
integer(c_int), value  itype,
integer(c_int), value  uplo,
integer(c_int), value  n,
type(c_ptr), value  a,
integer(c_int), value  lda,
integer(c_int64_t), value  stridea,
type(c_ptr), value  b,
integer(c_int), value  ldb,
integer(c_int64_t), value  strideb,
integer(c_int), value  batch_count 
)

◆ rocsolver_chegst_strided_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_chegst_strided_batched::rocsolver_chegst_strided_batched_full_rank ( type(c_ptr), value  handle,
integer(kind(rocblas_eform_ax))  itype,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex), dimension(:,:), target  a,
integer(c_int)  lda,
integer(c_int64_t)  stridea,
complex(c_float_complex), dimension(:,:), target  b,
integer(c_int)  ldb,
integer(c_int64_t)  strideb,
integer(c_int)  batch_count 
)

◆ rocsolver_chegst_strided_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_chegst_strided_batched::rocsolver_chegst_strided_batched_rank_0 ( type(c_ptr), value  handle,
integer(kind(rocblas_eform_ax))  itype,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex), target  a,
integer(c_int)  lda,
integer(c_int64_t)  stridea,
complex(c_float_complex), target  b,
integer(c_int)  ldb,
integer(c_int64_t)  strideb,
integer(c_int)  batch_count 
)

◆ rocsolver_chegst_strided_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_chegst_strided_batched::rocsolver_chegst_strided_batched_rank_1 ( type(c_ptr), value  handle,
integer(kind(rocblas_eform_ax))  itype,
integer(kind(rocblas_fill_upper))  uplo,
integer(c_int)  n,
complex(c_float_complex), dimension(:), target  a,
integer(c_int)  lda,
integer(c_int64_t)  stridea,
complex(c_float_complex), dimension(:), target  b,
integer(c_int)  ldb,
integer(c_int64_t)  strideb,
integer(c_int)  batch_count 
)

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