# rocsolver_cunmtr Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_cunmtr Interface Reference
hipfort_rocsolver::rocsolver_cunmtr Interface Reference

UNMTR multiplies a unitary matrix Q by a general m-by-n matrix C. More...

## Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_cunmtr_ (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)

integer(kind(rocblas_status_success)) function rocsolver_cunmtr_full_rank (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)

integer(kind(rocblas_status_success)) function rocsolver_cunmtr_rank_0 (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)

integer(kind(rocblas_status_success)) function rocsolver_cunmtr_rank_1 (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)

## Detailed Description

UNMTR multiplies a unitary 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^HC & \: \text{Conjugate transpose from the left,}\newline CQ & \: \text{No transpose from the right, and}\newline CQ^H & \: \text{Conjugate transpose from the right.} \end{array}$

The order q of the unitary 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 HETRD in its arguments A and tau.

Parameters
 [in] handle rocblas_handle. [in] side rocblas_side. Specifies from which side to apply Q. [in] uplo rocblas_fill. Specifies whether the HETRD factorization was upper or lower triangular. If uplo indicates lower (or upper), then the upper (or lower) part of A is not used. [in] trans rocblas_operation. Specifies whether the matrix Q or its conjugate 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] A pointer to type. Array on the GPU of size lda*q. On entry, the Householder vectors as returned by HETRD. [in] lda rocblas_int. lda >= q. Leading dimension of A. [in] ipiv pointer to type. Array on the GPU of dimension at least q-1. The Householder scalars as returned by HETRD. [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.

## ◆ rocsolver_cunmtr_()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cunmtr::rocsolver_cunmtr_ ( 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_cunmtr_full_rank()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cunmtr::rocsolver_cunmtr_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, complex(c_float_complex), dimension(:,:), target A, integer(c_int) lda, complex(c_float_complex), dimension(:), target ipiv, complex(c_float_complex), dimension(:,:), target C, integer(c_int) ldc )

## ◆ rocsolver_cunmtr_rank_0()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cunmtr::rocsolver_cunmtr_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, complex(c_float_complex), target A, integer(c_int) lda, complex(c_float_complex), target ipiv, complex(c_float_complex), target C, integer(c_int) ldc )

## ◆ rocsolver_cunmtr_rank_1()

 integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_cunmtr::rocsolver_cunmtr_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, complex(c_float_complex), dimension(:), target A, integer(c_int) lda, complex(c_float_complex), dimension(:), target ipiv, complex(c_float_complex), dimension(:), target C, integer(c_int) ldc )

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