# rocsolver_cungl2 Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_cungl2 Interface Reference
hipfort_rocsolver::rocsolver_cungl2 Interface Reference

UNGL2 generates an m-by-n complex Matrix Q with orthonormal rows. More...

## Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_cungl2_ (handle, m, n, k, A, lda, ipiv)

integer(kind(rocblas_status_success)) function rocsolver_cungl2_full_rank (handle, m, n, k, A, lda, ipiv)

integer(kind(rocblas_status_success)) function rocsolver_cungl2_rank_0 (handle, m, n, k, A, lda, ipiv)

integer(kind(rocblas_status_success)) function rocsolver_cungl2_rank_1 (handle, m, n, k, A, lda, ipiv)

## Detailed Description

UNGL2 generates an m-by-n complex Matrix Q with orthonormal rows.

(This is the unblocked version of the algorithm).

The matrix Q is defined as the first m rows of the product of k Householder reflectors of order n

$Q = H_k^HH_{k-1}^H\cdots H_1^H$

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 GELQF.

Parameters
 [in] handle rocblas_handle. [in] m rocblas_int. 0 <= m <= n. The number of rows of the matrix Q. [in] n rocblas_int. n >= 0. The number of columns of the matrix Q. [in] k rocblas_int. 0 <= k <= m. The number of Householder reflectors. [in,out] A pointer to type. Array on the GPU of dimension lda*n. On entry, the matrix A as returned by GELQF, with the Householder vectors in the first k rows. On exit, the computed matrix Q. [in] lda rocblas_int. lda >= m. Specifies the leading dimension of A. [in] ipiv pointer to type. Array on the GPU of dimension at least k. The Householder scalars as returned by GELQF.

## ◆ rocsolver_cungl2_()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungl2::rocsolver_cungl2_ ( 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_cungl2_full_rank()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungl2::rocsolver_cungl2_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_cungl2_rank_0()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungl2::rocsolver_cungl2_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_cungl2_rank_1()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cungl2::rocsolver_cungl2_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: