Intel® oneAPI Math Kernel Library (oneMKL) - Data Parallel C++ Developer Reference

Developer Reference

Contents

orgtr_scratchpad_size

Computes size of scratchpad memory required for
orgtr
 (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
orgtr
 (buffer or USM version) function should be able to hold.

API

Syntax
namespace oneapi::mkl::lapack {
  template<typename T>
  orgtr_scratchpad_size(cl::sycl::queue &queue,
  mkl::uplo uplo,
  std::int64_t n,
  std::int64_t lda)
}
Input Parameters
queue
Device queue where calculations by the orgtr (buffer or USM version) function will be performed.
uplo
Must be uplo::upper or uplo::lower. Uses the same uplo as supplied to the sytrd (USM Version) function.
n
The order of matrix
Q
 (
0≤n
).
lda
The leading dimension of
a
 (
n≤lda
).
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
orgtr
 (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.