Computes size of scratchpad memory required for potrs function.

Description

potrs_scratchpad_size supports the following precisions.

T

float

double

std::complex<float>

std::complex<double>

Computes the number of elements of type T the scratchpad memory to be passed to potrs 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 potrs_scratchpad_size(cl::sycl::queue &queue, oneapi::mkl::uplo upper_lower, std::int64_t n, std::int64_t nrhs, std::int64_t lda, std::int64_t ldb)
}


Input Parameters

queue

Device queue where calculations by potrs function will be performed.

upper_lower

Indicates how the input matrix has been factored:

If upper_lower = oneapi::mkl::uplo::upper, the upper triangle $$U$$ of $$A$$ is stored, where $$A = U^{T}U$$ for real data, $$A = U^{H}U$$ for complex data.

If upper_lower = oneapi::mkl::uplo::lower, the lower triangle $$L$$ of $$A$$ is stored, where $$A = LL^{T}$$ for real data, $$A = LL^{H}$$ for complex data.

n

The order of matrix $$A$$ ($$0 \le n$$).

nrhs

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

lda

The leading dimension of a.

ldb

The leading dimension of b.

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 potrs function should be able to hold.

Parent topic: LAPACK Linear Equation Routines