hipblaszgeqrf Interface Reference

hipblaszgeqrf Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblaszgeqrf Interface Reference
hipfort_hipblas::hipblaszgeqrf Interface Reference

SOLVER API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblaszgeqrf_ (handle, m, n, A, lda, ipiv, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgeqrf_full_rank (handle, m, n, A, lda, ipiv, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgeqrf_rank_0 (handle, m, n, A, lda, ipiv, myInfo)
 
integer(kind(hipblas_status_success)) function hipblaszgeqrf_rank_1 (handle, m, n, A, lda, ipiv, myInfo)
 

Detailed Description

SOLVER API.

geqrf computes a QR factorization of a general m-by-n matrix A.

The factorization has the form

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

where R is upper triangular (upper trapezoidal if m < n), and Q is a 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\).

Parameters
[in]handlehipblasHandle_t.
[in]mint. m >= 0.
The number of rows of the matrix A.
[in]nint. n >= 0.
The number of columns of the matrix A.
[in,out]Apointer 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]ldaint. lda >= m.
Specifies the leading dimension of A.
[out]ipivpointer to type. Array on the GPU of dimension min(m,n).
The Householder scalars.
[out]infopointer to a int on the host.
If info = 0, successful exit. If info = j < 0, the j-th argument is invalid.

Member Function/Subroutine Documentation

◆ hipblaszgeqrf_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrf::hipblaszgeqrf_ ( 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 
)

◆ hipblaszgeqrf_full_rank()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrf::hipblaszgeqrf_full_rank ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
complex(c_double_complex), dimension(:,:), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
type(c_ptr)  myInfo 
)

◆ hipblaszgeqrf_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrf::hipblaszgeqrf_rank_0 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
complex(c_double_complex), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
type(c_ptr)  myInfo 
)

◆ hipblaszgeqrf_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrf::hipblaszgeqrf_rank_1 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
complex(c_double_complex), dimension(:), target  A,
integer(c_int)  lda,
type(c_ptr)  ipiv,
type(c_ptr)  myInfo 
)

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