Contents

Computes size of scratchpad memory required for getrs function.

Description

T

float

double

std::complex<float>

std::complex<double>

Computes the number of elements of type T the scratchpad memory to be passed to getrs function should be able to hold. Calls to this routine must specify the template parameter explicitly.

Syntax

namespace oneapi::mkl::lapack {
template <typename T>
std::int64_t getrs_scratchpad_size(cl::sycl::queue &queue, oneapi::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 getrs function will be performed.

trans

Indicates the form of the equations:

If trans=oneapi::mkl::transpose::nontrans, then $$AX = B$$ is solved for $$X$$.

If trans=oneapi::mkl::transpose::trans, then $$A^TX = B$$ is solved for $$X$$.

If trans=oneapi::mkl::transpose::conjtrans, then $$A^HX = B$$ is solved for $$X$$.

n

The order of the matrix $$A$$ $$(0 \le n)$$ and the number of rows in matrix $$B(0 \le n)$$.

nrhs

The number of right-hand sides ($$0 \le \text{nrhs}$$).

lda

ldb

Throws

This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.

oneapi::mkl::unimplemented

oneapi::mkl::unsupported_device

oneapi::mkl::lapack::invalid_argument

Exception is thrown in case of incorrect supplied argument value. Position of wrong argument can be determined by info() method of exception object.

Return Value

The number of elements of type T the scratchpad memory to be passed to getrs function should be able to hold.

Parent topic: LAPACK Linear Equation Routines