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

rocsolver_cungql Interface Reference

rocsolver_cungql Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_cungql Interface Reference
hipfort_rocsolver::rocsolver_cungql Interface Reference

UNGQL generates an m-by-n complex Matrix Q with orthonormal columns. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_cungql_ (handle, m, n, k, A, lda, ipiv)
 
integer(kind(rocblas_status_success)) function rocsolver_cungql_full_rank (handle, m, n, k, A, lda, ipiv)
 
integer(kind(rocblas_status_success)) function rocsolver_cungql_rank_0 (handle, m, n, k, A, lda, ipiv)
 
integer(kind(rocblas_status_success)) function rocsolver_cungql_rank_1 (handle, m, n, k, A, lda, ipiv)
 

Detailed Description

UNGQL generates an m-by-n complex Matrix Q with orthonormal columns.

(This is the blocked version of the algorithm).

The matrix Q is defined as the last n columns of the product of k Householder reflectors of order m

\[ Q = H_kH_{k-1}\cdots H_1 \]

The Householder matrices \(H_i\) are never stored, they are computed from its corresponding Householder vectors \(v_i\) and scalars \(\text{ipiv}[i]\), as returned by GEQLF.

Parameters
[in]handlerocblas_handle.
[in]mrocblas_int. m >= 0.
The number of rows of the matrix Q.
[in]nrocblas_int. 0 <= n <= m.
The number of columns of the matrix Q.
[in]krocblas_int. 0 <= k <= n.
The number of Householder reflectors.
[in,out]Apointer to type. Array on the GPU of dimension lda*n.
On entry, the matrix A as returned by GEQLF, with the Householder vectors in the last k columns. On exit, the computed matrix Q.
[in]ldarocblas_int. lda >= m.
Specifies the leading dimension of A.
[in]ipivpointer to type. Array on the GPU of dimension at least k.
The Householder scalars as returned by GEQLF.

Member Function/Subroutine Documentation

◆ rocsolver_cungql_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungql::rocsolver_cungql_ ( type(c_ptr), value  handle,
integer(c_int), value  m,
integer(c_int), value  n,
integer(c_int), value  k,
type(c_ptr), value  A,
integer(c_int), value  lda,
type(c_ptr), value  ipiv 
)

◆ rocsolver_cungql_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungql::rocsolver_cungql_full_rank ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
integer(c_int)  k,
complex(c_float_complex), dimension(:,:), target  A,
integer(c_int)  lda,
complex(c_float_complex), dimension(:), target  ipiv 
)

◆ rocsolver_cungql_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungql::rocsolver_cungql_rank_0 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
integer(c_int)  k,
complex(c_float_complex), target  A,
integer(c_int)  lda,
complex(c_float_complex), target  ipiv 
)

◆ rocsolver_cungql_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungql::rocsolver_cungql_rank_1 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
integer(c_int)  k,
complex(c_float_complex), dimension(:), target  A,
integer(c_int)  lda,
complex(c_float_complex), dimension(:), target  ipiv 
)

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