Computes size of scratchpad memory required for hetrd function.

Description

hetrd_scratchpad_size supports the following precisions.

T

std::complex<float>

std::complex<double>

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


Input Parameters

queue

Device queue where calculations by hetrd function will be performed.

upper_lower

Must be uplo::upper or uplo::lower.

If upper_lower = uplo::upper, a stores the upper triangular part of $$A$$ and $$B$$.

If upper_lower = uplo::lower, a stores the lower triangular part of $$A$$.

n

The order of the matrices $$A$$ and $$B$$ ($$0 \le n$$).

lda

The leading dimension of a. Currently, lda is not referenced in this function.

Return Value

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