hipblaszgeqrfbatched Interface Reference#
hipfort_hipblas::hipblaszgeqrfbatched Interface Reference
SOLVER API. More...
Public Member Functions | |
integer(kind(hipblas_status_success)) function | hipblaszgeqrfbatched_ (handle, m, n, A, lda, ipiv, myInfo, batchCount) |
integer(kind(hipblas_status_success)) function | hipblaszgeqrfbatched_full_rank (handle, m, n, A, lda, ipiv, myInfo, batchCount) |
integer(kind(hipblas_status_success)) function | hipblaszgeqrfbatched_rank_0 (handle, m, n, A, lda, ipiv, myInfo, batchCount) |
integer(kind(hipblas_status_success)) function | hipblaszgeqrfbatched_rank_1 (handle, m, n, A, lda, ipiv, myInfo, batchCount) |
Detailed Description
SOLVER API.
geqrfBatched computes the QR factorization of a batch of general m-by-n matrices.
The factorization of matrix \(A_i\) in the batch has the form
\[ A_i = Q_i\left[\begin{array}{c} R_i\newline 0 \end{array}\right] \]
where \(R_i\) is upper triangular (upper trapezoidal if m < n), and \(Q_i\) is a m-by-m orthogonal/unitary matrix represented as the product of Householder matrices
\[ Q_i = H_{i_1}H_{i_2}\cdots H_{i_k}, \quad \text{with} \: k = \text{min}(m,n) \]
Each Householder matrix \(H_{i_j}\) is given by
\[ H_{i_j} = I - \text{ipiv}_i[j] \cdot v_{i_j} v_{i_j}' \]
where the first j-1 elements of Householder vector \(v_{i_j}\) are zero, and \(v_{i_j}[j] = 1\).
- Parameters
-
[in] handle hipblasHandle_t. [in] m int. m >= 0.
The number of rows of all the matrices A_i in the batch.[in] n int. n >= 0.
The number of columns of all the matrices A_i in the batch.[in,out] A Array of pointers to type. Each pointer points to an array on the GPU of dimension lda*n.
On entry, the m-by-n matrices A_i to be factored. On exit, the elements on and above the diagonal contain the factor R_i. The elements below the diagonal are the last m - j elements of Householder vector v_(i_j).[in] lda int. lda >= m.
Specifies the leading dimension of matrices A_i.[out] ipiv array of pointers to type. Each pointer points to an array on the GPU of dimension min(m, n).
Contains the vectors ipiv_i of corresponding Householder scalars.[out] info pointer to a int on the host.
If info = 0, successful exit. If info = k < 0, the k-th argument is invalid.[in] batchCount int. batchCount >= 0.
Number of matrices in the batch.
Member Function/Subroutine Documentation
◆ hipblaszgeqrfbatched_()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrfbatched::hipblaszgeqrfbatched_ | ( | type(c_ptr), value | handle, |
integer(c_int), value | m, | ||
integer(c_int), value | n, | ||
type(c_ptr) | A, | ||
integer(c_int), value | lda, | ||
type(c_ptr) | ipiv, | ||
type(c_ptr), value | myInfo, | ||
integer(c_int), value | batchCount | ||
) |
◆ hipblaszgeqrfbatched_full_rank()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrfbatched::hipblaszgeqrfbatched_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, | ||
integer(c_int) | batchCount | ||
) |
◆ hipblaszgeqrfbatched_rank_0()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrfbatched::hipblaszgeqrfbatched_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, | ||
integer(c_int) | batchCount | ||
) |
◆ hipblaszgeqrfbatched_rank_1()
integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblaszgeqrfbatched::hipblaszgeqrfbatched_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, | ||
integer(c_int) | batchCount | ||
) |
The documentation for this interface was generated from the following file: