rocsolver_sormbr Interface Reference#
ORMBR multiplies a matrix Q with orthonormal rows or columns by a general m-by-n matrix C. More...
Public Member Functions | |
| integer(kind(rocblas_status_success)) function | rocsolver_sormbr_ (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc) |
| integer(kind(rocblas_status_success)) function | rocsolver_sormbr_full_rank (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc) |
| integer(kind(rocblas_status_success)) function | rocsolver_sormbr_rank_0 (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc) |
| integer(kind(rocblas_status_success)) function | rocsolver_sormbr_rank_1 (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc) |
Detailed Description
ORMBR multiplies a matrix Q with orthonormal rows or columns by a general m-by-n matrix C.
If storev is column-wise, then the matrix Q has orthonormal columns. If storev is row-wise, then the matrix Q has orthonormal rows. 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,}\newline Q^TC & \: \text{Transpose from the left,}\newline CQ & \: \text{No transpose from the right, and}\newline CQ^T & \: \text{Transpose from the right.} \end{array} \]
The order q of the orthogonal matrix Q is q = m if applying from the left, or q = n if applying from the right.
When storev is column-wise, if q >= k, then Q is defined as the product of k Householder reflectors
\[ Q = H_1H_2\cdots H_k, \]
and if q < k, then Q is defined as the product
\[ Q = H_1H_2\cdots H_{q-1}. \]
When storev is row-wise, if q > k, then Q is defined as the product of k Householder reflectors
\[ Q = H_1H_2\cdots H_k, \]
and if q <= k, Q is defined as the product
\[ Q = H_1H_2\cdots H_{q-1}. \]
The Householder matrices \(H_i\) are never stored, they are computed from its corresponding Householder vectors and scalars as returned by GEBRD in its arguments A and tauq or taup.
- Parameters
-
[in] handle rocblas_handle. [in] storev rocblas_storev.
Specifies whether to work column-wise or row-wise.[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.
The number of columns (if storev is column-wise) or rows (if row-wise) of the original matrix reduced by GEBRD.[in] A pointer to type. Array on the GPU of size lda*min(q,k) if column-wise, or lda*q if row-wise.
The Householder vectors as returned by GEBRD.[in] lda rocblas_int. lda >= q if column-wise, or lda >= min(q,k) if row-wise.
Leading dimension of A.[in] ipiv pointer to type. Array on the GPU of dimension at least min(q,k).
The Householder scalars as returned by GEBRD.[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 Q*C, C*Q, Q'*C, or C*Q'.[in] ldc rocblas_int. ldc >= m.
Leading dimension of C.
Member Function/Subroutine Documentation
◆ rocsolver_sormbr_()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_ | ( | type(c_ptr), value | handle, |
| integer(kind(rocblas_column_wise)), value | storev, | ||
| 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_sormbr_full_rank()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_full_rank | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_column_wise)) | storev, | ||
| 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_sormbr_rank_0()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_rank_0 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_column_wise)) | storev, | ||
| 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_sormbr_rank_1()
| integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_rank_1 | ( | type(c_ptr) | handle, |
| integer(kind(rocblas_column_wise)) | storev, | ||
| 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: