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

Developer Reference

Contents

getrs_scratchpad_size

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

API

Syntax
namespace oneapi::mkl::lapack {
  template<typename T>
  std::int64_t getrs_scratchpad_size(cl::sycl::queue &queue,
  mkl::transpose trans,
  std::int64_t n,
  std::int64_t nrhs,
  std::int64_t lda,
  std::int64_t ldb)
}
Input Parameters
queue
Device queue where calculations by the getrs (buffer or USM version) function will be performed.
trans
Indicates the form of the equations:
If
trans=mkl::transpose::nontrans
, then
A*X = B
 is solved for
X
.
If
trans=mkl::transpose::trans
, then
AT*X = B
 is solved for
X
.
If
trans=mkl::transpose::conjtrans
, then
AH*X = B
 is solved for
X
.
n
The order of the matrix
A
 and the number of rows in matrix
B(0≤n)
.
nrhs
The number of right-hand sides (
0≤nrhs
).
lda
The leading dimension of a.
ldb
The leading dimension of b.
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
getrs
 (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.