Developer Reference

Contents

ungbr_scratchpad_size

Computes size of scratchpad memory required for
ungbr
(USM Version) function. This routine belongs to the
oneapi::mkl::lapack
namespace.

Description

Computes the number of elements of type
T
the scratchpad memory to be passed to the
ungbr
(buffer or USM version) function should be able to hold.

API

Syntax
namespace oneapi::mkl::lapack { template<typename T> std::int64_t ungbr_scratchpad_size(cl::sycl::queue &queue, mkl::generate gen, std::int64_t m, std::int64_t n, std::int64_t k, std::int64_t lda) }
Input Parameters
queue
Device queue where calculations by the ungbr (buffer or USM version) function will be performed.
gen
Must be
generate::q
or
generate::p
.
If gen
= generate::q
, the routine generates the matrix
Q
.
If gen
= generate::p
, the routine generates the matrix
P
T
.
m
The number of rows in the matrix
Q
or
P
T
to be returned
(0≤m)
.
If gen
= generate::q
,
m ≥ n ≥ min(m, k)
.
If gen
= generate::p
,
n ≥ m ≥ min(n, k)
.
n
The number of rows in the matrix
Q
or
P
T
to be returned
(0≤n)
. See m for constraints.
k
If gen
= generate::q
, the number of columns in the original
m
-by-k matrix reduced by gebrd (USM Version).
If gen
= generate::p
, the number of rows in the original
k
-by-n matrix reduced by gebrd (USM Version).
lda
The leading dimension of a.
Exceptions
Exception
Description
mkl::lapack::exception
This exception is thrown when an incorrect argument value is supplied. You can determine the position of the incorrect argument by the info() method of the exception object.
Return Values
The number of elements of type
T
the scratchpad memory to be passed to the
ungbr
(buffer or USM version) function should be able to hold.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.