rocsolver_sgeql2 Interface Reference

• hipfort_rocsolver
• rocsolver_sgeql2

Public Member Functions | List of all members

hipfort_rocsolver::rocsolver_sgeql2 Interface Reference

The GEQL2 functions compute a QL factorization of a general m -by-n matrix A. More...

Public Member Functions
integer(kind(rocblas_status_success)) function	rocsolver_sgeql2_ (handle, m, n, a, lda, ipiv)
integer(kind(rocblas_status_success)) function	rocsolver_sgeql2_rank_0 (handle, m, n, a, lda, ipiv)
integer(kind(rocblas_status_success)) function	rocsolver_sgeql2_rank_1 (handle, m, n, a, lda, ipiv)
integer(kind(rocblas_status_success)) function	rocsolver_sgeql2_full_rank (handle, m, n, a, lda, ipiv)

Detailed Description

The GEQL2 functions compute a QL factorization of a general m -by-n matrix A.

(This is the unblocked version of the algorithm.)

The factorization has the form

\[ A = Q\left[\begin{array}{c} 0\\% L \end{array}\right] \]

where L is lower triangular (lower trapezoidal if m < n), and Q is an m -by-m orthogonal/unitary matrix represented as the product of Householder matrices

\[ Q = H(k)H(k-1)\cdots H(1), \quad \text{with} \: k = \text{min}(m,n) \]

Each Householder matrix \(H(i)\) is given by

\[ H(i) = I - \text{ipiv}[i] \cdot v_i^{} v_i^H \]

where the last m-i elements of the Householder vector \(v_i\) are zero, and \(v_i[i] = 1\).

Parameters

[in]	handle	- rocblas_handle.
[in]	m	- rocblas_int. m >= 0. The number of rows of the matrix A.
[in]	n	- rocblas_int. n >= 0. The number of columns of the matrix A.
[in,out]	A	- pointer to type. Array on the GPU of dimension lda*n. On entry, the m-by-n matrix to be factored. On exit, the elements on and below the (m-n)-th subdiagonal (when m >= n) or the (n-m)-th superdiagonal (when n > m) contain the factor L, and the elements above the sub/superdiagonal are the first i - 1 elements of Householder vector v_i.
[in]	lda	- rocblas_int. lda >= m. Specifies the leading dimension of A.
[out]	ipiv	- pointer to type. Array on the GPU of dimension min(m,n). The Householder scalars.

Member Function/Subroutine Documentation

◆ rocsolver_sgeql2_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgeql2::rocsolver_sgeql2_	(	type(c_ptr), value	handle,
		integer(c_int), value	m,
		integer(c_int), value	n,
		type(c_ptr), value	a,
		integer(c_int), value	lda,
		type(c_ptr), value	ipiv
	)

◆ rocsolver_sgeql2_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgeql2::rocsolver_sgeql2_full_rank	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		real(c_float), dimension(:,:), target	a,
		integer(c_int)	lda,
		real(c_float), dimension(:), target	ipiv
	)

◆ rocsolver_sgeql2_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgeql2::rocsolver_sgeql2_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		real(c_float), target	a,
		integer(c_int)	lda,
		real(c_float), target	ipiv
	)

◆ rocsolver_sgeql2_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgeql2::rocsolver_sgeql2_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	m,
		integer(c_int)	n,
		real(c_float), dimension(:), target	a,
		integer(c_int)	lda,
		real(c_float), dimension(:), target	ipiv
	)

---

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

• hipfort_rocsolver.F90