rocsolver_sorml2 Interface Reference#
The ORML2 functions multiply a matrix Q with orthonormal rows by a general m -by-n matrix C.
More...
Public Member Functions | |
| integer(kind(rocblas_status_success)) function | rocsolver_sorml2_ (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc) |
| integer(kind(rocblas_status_success)) function | rocsolver_sorml2_rank_0 (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc) |
| integer(kind(rocblas_status_success)) function | rocsolver_sorml2_rank_1 (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc) |
| integer(kind(rocblas_status_success)) function | rocsolver_sorml2_full_rank (handle, side, trans, m, n, k, a, lda, ipiv, c, ldc) |
Detailed Description
The ORML2 functions multiply a matrix Q with orthonormal rows by a general m -by-n matrix C.
(This is the unblocked version of the algorithm.)
The matrix Q is applied in one of the following forms, depending on the values of side and trans:
\[ \begin{array}{cl} QC & \: \text{No transpose from the left,}\\% Q^TC & \: \text{Transpose from the left,}\\% CQ & \: \text{No transpose from the right, and}\\% CQ^T & \: \text{Transpose from the right.} \end{array} \]
Q is defined as the product of k Householder reflectors
\[ Q = H(k)H(k-1)\cdots H(1) \]
of order m if applying from the left, or n if applying from the right. Q is never stored. It is calculated from the Householder vectors and scalars returned by the LQ factorization GELQF.
- Parameters
-
[in] handle - rocblas_handle. [in] side - rocblas_side. Specifies from which side to apply Q. [in] trans - rocblas_operation. Specifies whether the matrix Q or its transpose is to be applied. [in] m - rocblas_int. m >= 0. Number of rows of matrix C. [in] n - rocblas_int. n >= 0. Number of columns of matrix C. [in] k - rocblas_int. k >= 0. k <= m if side is left, and k <= n if side is right. The number of Householder reflectors that form Q. [in] A - pointer to type. Array on the GPU of size lda*m if side is left, or lda*n if side is right. The Householder vectors as returned by GELQF in the first k rows of its argument A. [in] lda - rocblas_int. lda >= k. Leading dimension of A. [in] ipiv - pointer to type. Array on the GPU of dimension at least k. The Householder scalars as returned by GELQF. [in,out] C - pointer to type. Array on the GPU of size ldc*n. On entry, the matrix C. On exit, it is overwritten with \(QC\), \(CQ\), \(Q^TC\), or \(CQ^T\). [in] ldc - rocblas_int. ldc >= m. Leading dimension of C.
Member Function/Subroutine Documentation
◆ rocsolver_sorml2_()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sorml2::rocsolver_sorml2_ | ( | type(c_ptr), value | handle, |
| integer(kind(rocblas_side_left)), value | side, | ||
| integer(kind(rocblas_operation_none)), value | trans, | ||
| integer(c_int), value | m, | ||
| integer(c_int), value | n, | ||
| integer(c_int), value | k, | ||
| type(c_ptr), value | a, | ||
| integer(c_int), value | lda, | ||
| type(c_ptr), value | ipiv, | ||
| type(c_ptr), value | c, | ||
| integer(c_int), value | ldc | ||
| ) |
◆ rocsolver_sorml2_full_rank()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sorml2::rocsolver_sorml2_full_rank | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_side_left)) | side, | ||
| integer(kind(rocblas_operation_none)) | trans, | ||
| integer(c_int) | m, | ||
| integer(c_int) | n, | ||
| integer(c_int) | k, | ||
| real(c_float), dimension(:,:), target | a, | ||
| integer(c_int) | lda, | ||
| real(c_float), dimension(:), target | ipiv, | ||
| real(c_float), dimension(:,:), target | c, | ||
| integer(c_int) | ldc | ||
| ) |
◆ rocsolver_sorml2_rank_0()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sorml2::rocsolver_sorml2_rank_0 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_side_left)) | side, | ||
| integer(kind(rocblas_operation_none)) | trans, | ||
| integer(c_int) | m, | ||
| integer(c_int) | n, | ||
| integer(c_int) | k, | ||
| real(c_float), target | a, | ||
| integer(c_int) | lda, | ||
| real(c_float), target | ipiv, | ||
| real(c_float), target | c, | ||
| integer(c_int) | ldc | ||
| ) |
◆ rocsolver_sorml2_rank_1()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sorml2::rocsolver_sorml2_rank_1 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_side_left)) | side, | ||
| integer(kind(rocblas_operation_none)) | trans, | ||
| integer(c_int) | m, | ||
| integer(c_int) | n, | ||
| integer(c_int) | k, | ||
| real(c_float), dimension(:), target | a, | ||
| integer(c_int) | lda, | ||
| real(c_float), dimension(:), target | ipiv, | ||
| real(c_float), dimension(:), target | c, | ||
| integer(c_int) | ldc | ||
| ) |
The documentation for this interface was generated from the following file: