Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

?upmtr

Multiplies a complex matrix by the unitary matrix Q determined by ?hptrd.

Syntax

call cupmtr(side, uplo, trans, m, n, ap, tau, c, ldc, work, info)

call zupmtr(side, uplo, trans, m, n, ap, tau, c, ldc, work, info)

call upmtr(ap, tau, c [,side] [,uplo] [,trans] [,info])

Include Files

  • mkl.fi, lapack.f90

Description

The routine multiplies a complex matrix C by Q or QH, where Q is the unitary matrix formed by hptrd when reducing a packed complex Hermitian matrix A to tridiagonal form: A = Q*T*QH. Use this routine after a call to ?hptrd.

Depending on the parameters side and trans, the routine can form one of the matrix products Q*C, QH*C, C*Q, or C*QH (overwriting the result on C).

Input Parameters

In the descriptions below, r denotes the order of Q:

If side = 'L', r = m; if side = 'R', r = n.

side

CHARACTER*1. Must be either 'L' or 'R'.

If side = 'L', Q or QH is applied to C from the left.

If side = 'R', Q or QH is applied to C from the right.

uplo

CHARACTER*1. Must be 'U' or 'L'.

Use the same uplo as supplied to ?hptrd.

trans

CHARACTER*1. Must be either 'N' or 'T'.

If trans = 'N', the routine multiplies C by Q.

If trans = 'T', the routine multiplies C by QH.

m

INTEGER. The number of rows in the matrix C (m 0).

n

INTEGER. The number of columns in C (n 0).

ap, tau, c,

COMPLEX for cupmtr

DOUBLE COMPLEX for zupmtr.

ap and tau are the arrays returned by ?hptrd.

The size of ap must be at least max(1, r(r+1)/2).

The size of tau must be at least max(1, r-1).

c(ldc,*) contains the matrix C.

The second dimension of c must be at least max(1, n)

work(*) is a workspace array.

The dimension of work must be at least

max(1, n) if side = 'L';

max(1, m) if side = 'R'.

ldc

INTEGER. The leading dimension of c; ldc max(1, m) .

Output Parameters

c

Overwritten by the product Q*C, QH*C, C*Q, or C*QH (as specified by side and trans).

info

INTEGER.

If info = 0, the execution is successful.

If info = -i, the i-th parameter had an illegal value.

LAPACK 95 Interface Notes

Routines in Fortran 95 interface have fewer arguments in the calling sequence than their FORTRAN 77 counterparts. For general conventions applied to skip redundant or restorable arguments, see LAPACK 95 Interface Conventions.

Specific details for the routine upmtr interface are the following:

ap

Holds the array A of size (r*(r+1)/2), where

r = m if side = 'L'.

r = n if side = 'R'.

tau

Holds the vector with the number of elements n - 1.

c

Holds the matrix C of size (m,n).

side

Must be 'L' or 'R'. The default value is 'L'.

uplo

Must be 'U' or 'L'.The default value is 'U'.

trans

Must be 'N' or 'C'. The default value is 'N'.

Application Notes

The computed product differs from the exact product by a matrix E such that ||E||2 = O(ε)*||C||2, where ε is the machine precision.

The total number of floating-point operations is approximately 8*m2*n if side = 'L' or 8*n2*m if side = 'R'.

The real counterpart of this routine is opmtr.