rocsolver_cunmql Interface Reference

rocsolver_cunmql Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_cunmql Interface Reference

The UNMQL functions multiply a complex matrix Q with orthonormal columns by a general m-by-n matrix C. More...

Public Member Functions
integer(kind(rocblas_status_success)) function	rocsolver_cunmql_ (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc)

integer(kind(rocblas_status_success)) function	rocsolver_cunmql_rank_0 (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc)

integer(kind(rocblas_status_success)) function	rocsolver_cunmql_rank_1 (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc)

integer(kind(rocblas_status_success)) function	rocsolver_cunmql_full_rank (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc)

Detailed Description

The UNMQL functions multiply a complex matrix Q with orthonormal columns by a general m-by-n matrix C.

(This is the blocked version of the algorithm.)

The matrix Q is applied in one of the following forms, depending on the values of side and trans:

\[ \begin{array}{cl} QC & \: \text{No transpose from the left,}\\% Q^H C & \: \text{Conjugate transpose from the left,}\\% CQ & \: \text{No transpose from the right, and}\\% CQ^H & \: \text{Conjugate transpose from the right.} \end{array} \]

Q is defined as the product of k Householder reflectors

\[ Q = H(k)H(k-1)\cdots H(1) \]

of order m if applying from the left, or n if applying from the right. Q is never stored. It is calculated from the Householder vectors and scalars returned by the QL factorization GEQLF.

Parameters

[in]	handle	- rocblas_handle.
[in]	side	- rocblas_side. Specifies from which side to apply Q.
[in]	trans	- rocblas_operation. Specifies whether the matrix Q or its conjugate transpose is to be applied.
[in]	m	- rocblas_int. m >= 0. Number of rows of matrix C.
[in]	n	- rocblas_int. n >= 0. Number of columns of matrix C.
[in]	k	- rocblas_int. k >= 0. k <= m if side is left, and k <= n if side is right. The number of Householder reflectors that form Q.
[in]	A	- pointer to type. Array on the GPU of size lda*k. The Householder vectors as returned by GEQLF in the last k columns of its argument A.
[in]	lda	- rocblas_int. lda >= m if side is left, and lda >= n if side is right. Leading dimension of A.
[in]	ipiv	- pointer to type. Array on the GPU of dimension at least k. The Householder scalars as returned by GEQLF.
[in,out]	C	- pointer to type. Array on the GPU of size ldc*n. On entry, the matrix C. On exit, it is overwritten with \(QC\), \(CQ\), \(Q^HC\), or \(CQ^H\).
[in]	ldc	- rocblas_int. ldc >= m. Leading dimension of C.

Member Function/Subroutine Documentation