This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

rocsolver_sormtr Interface Reference

rocsolver_sormtr Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_sormtr Interface Reference
hipfort_rocsolver::rocsolver_sormtr Interface Reference

ORMTR multiplies an orthogonal matrix Q by a general m-by-n matrix C. More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_sormtr_ (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)
 
integer(kind(rocblas_status_success)) function rocsolver_sormtr_full_rank (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)
 
integer(kind(rocblas_status_success)) function rocsolver_sormtr_rank_0 (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)
 
integer(kind(rocblas_status_success)) function rocsolver_sormtr_rank_1 (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)
 

Detailed Description

ORMTR multiplies an orthogonal matrix Q by a general m-by-n matrix C.

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.

Q is defined as a product of q-1 Householder reflectors. If uplo indicates upper, then Q has the form

\[ Q = H_{q-1}H_{q-2}\cdots H_1. \]

On the other hand, if uplo indicates lower, then Q has the form

\[ 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 SYTRD in its arguments A and tau.

Parameters
[in]handlerocblas_handle.
[in]siderocblas_side.
Specifies from which side to apply Q.
[in]uplorocblas_fill.
Specifies whether the SYTRD factorization was upper or lower triangular. If uplo indicates lower (or upper), then the upper (or lower) part of A is not used.
[in]transrocblas_operation.
Specifies whether the matrix Q or its transpose is to be applied.
[in]mrocblas_int. m >= 0.
Number of rows of matrix C.
[in]nrocblas_int. n >= 0.
Number of columns of matrix C.
[in]Apointer to type. Array on the GPU of size lda*q.
On entry, the Householder vectors as returned by SYTRD.
[in]ldarocblas_int. lda >= q.
Leading dimension of A.
[in]ipivpointer to type. Array on the GPU of dimension at least q-1.
The Householder scalars as returned by SYTRD.
[in,out]Cpointer 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]ldcrocblas_int. ldc >= m.
Leading dimension of C.

Member Function/Subroutine Documentation

◆ rocsolver_sormtr_()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_ ( type(c_ptr), value  handle,
integer(kind(rocblas_side_left)), value  side,
integer(kind(rocblas_fill_upper)), value  uplo,
integer(kind(rocblas_operation_none)), value  trans,
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  C,
integer(c_int), value  ldc 
)

◆ rocsolver_sormtr_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_full_rank ( type(c_ptr)  handle,
integer(kind(rocblas_side_left))  side,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  trans,
integer(c_int)  m,
integer(c_int)  n,
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_sormtr_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_rank_0 ( type(c_ptr)  handle,
integer(kind(rocblas_side_left))  side,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  trans,
integer(c_int)  m,
integer(c_int)  n,
real(c_float), target  A,
integer(c_int)  lda,
real(c_float), target  ipiv,
real(c_float), target  C,
integer(c_int)  ldc 
)

◆ rocsolver_sormtr_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_rank_1 ( type(c_ptr)  handle,
integer(kind(rocblas_side_left))  side,
integer(kind(rocblas_fill_upper))  uplo,
integer(kind(rocblas_operation_none))  trans,
integer(c_int)  m,
integer(c_int)  n,
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: