hipblassgeqrf Interface Reference

• hipfort_hipblas
• hipblassgeqrf

Public Member Functions | List of all members

hipfort_hipblas::hipblassgeqrf Interface Reference

SOLVER API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblassgeqrf_ (handle, m, n, a, lda, ipiv, myinfo)
integer(kind(hipblas_status_success)) function	hipblassgeqrf_rank_0 (handle, m, n, a, lda, ipiv, myinfo)
integer(kind(hipblas_status_success)) function	hipblassgeqrf_rank_1 (handle, m, n, a, lda, ipiv, myinfo)
integer(kind(hipblas_status_success)) function	hipblassgeqrf_full_rank (handle, m, n, a, lda, ipiv, myinfo)

Detailed Description

SOLVER API.

The geqrf functions compute a QR factorization of a general m -by-n matrix A. The factorization has the form:

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

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

\[ Q = H_1H_2\cdots H_k, \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' \]

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

• Supported precisions in rocSOLVER : s, d, c, and z.
• Supported precisions in cuBLAS : s, d, c, and z.

Parameters

[in]	handle	- hipblasHandle_t.
[in]	m	- int. m >= 0. The number of rows of the matrix A.
[in]	n	- 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 above the diagonal contain the factor R. The elements below the diagonal are the last m - i elements of Householder vector v_i.
[in]	lda	- 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.
[out]	myInfo	- pointer to a int on the host. If info = 0, successful exit. If info = j < 0, the argument at position -j is invalid.

Member Function/Subroutine Documentation

◆ hipblassgeqrf_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgeqrf::hipblassgeqrf_	(	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,
		type(c_ptr), value	myinfo
	)

◆ hipblassgeqrf_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgeqrf::hipblassgeqrf_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,
		type(c_ptr)	myinfo
	)

◆ hipblassgeqrf_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgeqrf::hipblassgeqrf_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,
		type(c_ptr)	myinfo
	)

◆ hipblassgeqrf_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassgeqrf::hipblassgeqrf_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,
		type(c_ptr)	myinfo
	)

---

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

• hipfort_hipblas.F90