rocsolver_sgeql2_batched Interface Reference

rocsolver_sgeql2_batched Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_sgeql2_batched Interface Reference
hipfort_rocsolver::rocsolver_sgeql2_batched Interface Reference

The GEQL2_BATCHED functions compute the QL factorization of a batch of general m-by-n matrices. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_sgeql2_batched_ (handle, m, n, a, lda, ipiv, stridep, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_sgeql2_batched_rank_0 (handle, m, n, a, lda, ipiv, stridep, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_sgeql2_batched_rank_1 (handle, m, n, a, lda, ipiv, stridep, batch_count)
 

Detailed Description

The GEQL2_BATCHED functions compute the QL factorization of a batch of general m-by-n matrices.

(This is the unblocked version of the algorithm.)

The factorization of matrix \(A_l\) in the batch has the form

\[ A_l = Q_l\left[\begin{array}{c} 0\\% L_l \end{array}\right] \]

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

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

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

\[ H_l^{}(i) = I - \text{ipiv}_l^{}[i] \cdot v_{l_i}^{} v_{l_i}^H \]

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

Parameters
[in]handle- rocblas_handle.
[in]m- rocblas_int. m >= 0. The number of rows of all the matrices A_l in the batch.
[in]n- rocblas_int. n >= 0. The number of columns of all the matrices A_l 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_l 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_l, and the elements above the sub/superdiagonal are the first i - 1 elements of Householder vector v_(l_i).
[in]lda- rocblas_int. lda >= m. Specifies the leading dimension of matrices A_l.
[out]ipiv- pointer to type. Array on the GPU (the size depends on the value of strideP). Contains the vectors ipiv_l of corresponding Householder scalars.
[in]strideP- rocblas_stride. Stride from the start of one vector ipiv_l to the next one ipiv_(l+1). There is no restriction for the value of strideP. The normal use is strideP >= min(m,n).
[in]batch_count- rocblas_int. batch_count >= 0. Number of matrices in the batch.

Member Function/Subroutine Documentation

◆ rocsolver_sgeql2_batched_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgeql2_batched::rocsolver_sgeql2_batched_ ( 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,
integer(c_int64_t), value  stridep,
integer(c_int), value  batch_count 
)

◆ rocsolver_sgeql2_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgeql2_batched::rocsolver_sgeql2_batched_rank_0 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
type(c_ptr)  a,
integer(c_int)  lda,
real(c_float), target  ipiv,
integer(c_int64_t)  stridep,
integer(c_int)  batch_count 
)

◆ rocsolver_sgeql2_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgeql2_batched::rocsolver_sgeql2_batched_rank_1 ( type(c_ptr)  handle,
integer(c_int)  m,
integer(c_int)  n,
type(c_ptr)  a,
integer(c_int)  lda,
real(c_float), dimension(:), target  ipiv,
integer(c_int64_t)  stridep,
integer(c_int)  batch_count 
)

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