getrf_scratchpad_size

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

API

Syntax

namespace oneapi::mkl::lapack {
  template<typename T>
  std::int64_t getrf_scratchpad_size(cl::sycl::queue &queue,
  std::int64_t m,
  std::int64_t n,
  std::int64_t lda)
}

Input Parameters

queue

Device queue where calculations by the getrf (buffer or USM version) function will be performed.

m

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

n

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

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 getrf (buffer or USM version) function should be able to hold.