unmtr (USM Version)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 3/22/2024

Version

Public

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

Visible to Intel only — GUID: GUID-983EA097-2ECE-4AAC-86D7-EA84B4BEB556

View Details

unmtr (USM Version)

Multiplies a complex matrix by the complex unitary matrix Q determined by the hetrd (USM Version) function. This routine belongs to the oneapi::mkl::lapack namespace.

Description
API

Description

The routine multiplies a complex matrix C by Q or Q^H, where Q is the unitary matrix Q formed by hetrd (USM Version) when reducing a complex Hermitian matrix A to tridiagonal form: A = Q*T*QT. Use this routine after a call to hetrd (USM Version).

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

API

Syntax

namespace oneapi::mkl::lapack {
  sycl::event unmtr(sycl::queue &queue,
  mkl::side side,
  mkl::uplo uplo,
  mkl::transpose trans,
  std::int64_t m,
  std::int64_t n,
  T *a,
  std::int64_t lda,
  T *tau,
  T *c,
  std::int64_t ldc,
  T *scratchpad,
  std::int64_t scratchpad_size,
  const std::vector<sycl::event> &events = {})
}

unmtr (USM version) supports the following precisions and devices:

T	Devices supported
`std::complex<float>`	CPU
`std::complex<double>`	CPU

Input Parameters

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

`r = m`	if `side = side::left`
`r = n`	if `side = side::right`

queue

Device queue where calculations will be performed.

side

Must be either side::left or side::right.

If side = side::left, Q or Q^T is applied to C from the left.

If side = side::right, Q or Q^T is applied to C from the right.

uplo

Must be either uplo::upper or uplo::lower. Uses the same uplo as supplied to hetrd (USM Version).

trans

Must be either transpose::nontrans or transpose::trans.

If trans = transpose::nontrans, the routine multiplies C by Q.

If trans = transpose::trans, the routine multiplies C by Q^T.

m

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

n

The number of columns in the matrix C(n ≥ 0).

a

The pointer to memory returned by hetrd (USM Version).

lda

The leading dimension of a(lda ≥ max(1, r)).

tau

The pointer to tau returned by hetrd (USM Version). The dimension of tau must be at least max(1, r-1).

c

The pointer to memory containing the matrix C. The second dimension of c must be at least max(1, n).

ldc

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

scratchpad

Pointer to scratchpad memory to be used by the routine for storing intermediate results.

scratchpad_size

Size of scratchpad memory as a number of floating point elements of type T. Size should not be less than the value returned by the unmtr_scratchpad_size function.

events

List of events to wait for before starting computation. Defaults to empty list.

Output Parameters

c: Overwritten by the product Q*C, Q^T*C, C*Q, or C*Q^T (as specified by side and trans).

Exceptions

Exception	Description
`mkl::lapack::exception`	This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the info() method of the exception object: If `info = -i`, the `i`-th parameter had an illegal value. If `info` is equal to the value passed as scratchpad size, and detail() returns non-zero, then the passed scratchpad has an insufficient size, and the required size should not be less than the value returned by the detail() method of the exception object.

Exception

Description

mkl::lapack::exception

This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the info() method of the exception object:

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

If info is equal to the value passed as scratchpad size, and detail() returns non-zero, then the passed scratchpad has an insufficient size, and the required size should not be less than the value returned by the detail() method of the exception object.

Return Values

Output event to wait on to ensure computation is complete.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

unmtr (USM Version)

Description

API