Contents

ormqr

Multiplies a real matrix by the orthogonal matrix Q of the QR factorization formed by geqrf. This routine belongs to the oneapi::mkl::lapack namespace.

Description

The routine multiplies a real matrix C by Q or QT, where Q is the orthogonal matrix Q of the QR factorization formed by the routine geqrf.

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

API

Syntax

namespace oneapi::mkl::lapack {
  void ormqr(cl::sycl::queue &queue,
  mkl::side side,
  mkl::transpose trans,
  std::int64_t m,
  std::int64_t n,
  std::int64_t k,
  cl::sycl::buffer<T> &a,
  std::int64_t lda,
  cl::sycl::buffer<T> &tau,
  cl::sycl::buffer<T> &c,
  std::int64_t ldc,
  cl::sycl::buffer<T> &scratchpad,
  std::int64_t scratchpad_size)
}

ormqr supports the following precisions and devices:

T

Devices supported

float

Host, CPU, and GPU

double

Host, CPU, and GPU

Input Parameters

queue

Device queue where calculations will be performed.

side

If side = mkl::side::left, Q or QT is applied to C from the left. If side = mkl::side::right, Q or QT is applied to C from the right.

trans

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

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

m

The number of rows in the matrix A (0≤m).

n

The number of columns in the matrix A (0≤n≤m).

k

The number of elementary reflectors whose product defines the matrix Q (0≤k≤n).

a

Buffer holding the result of the geqrf function. . The second dimension of a must be at least max(1,k).

lda

The leading dimension of a.

tau

Buffer holding tau returned by the geqrf function.

c

Buffer holding the matrix C. The second dimension of c must be at least max(1,n).

ldc

The leading dimension of c.

scratchpad

Buffer holding 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 ormqr_scratchpad_size function.

Output Parameters

c

Overwritten by the product Q*C, QT*C, C*Q, or C*QT (as specified by left_right 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.
orgtr_scratchpad_size ormqr (USM Version)