heevd_scratchpad_size

Computes size of scratchpad memory required for heevd function.

heevd_scratchpad_size supports the following precisions.

T

std::complex<float>

std::complex<double>

Description

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

heevd_scratchpad_size

Syntax

template<typename T>
std::int64_t onemkl::lapack::heevd_scratchpad_size(cl::sycl::queue &queue, onemkl::job jobz, onemkl::uplo upper_lower, std::int64_t n, std::int64_t lda)

Input Parameters

queue

Device queue where calculations by heevd function will be performed.

jobz

Must be job::novec or job::vec.

If jobz = job::novec, then only eigenvalues are computed.

If jobz = job::vec, then eigenvalues and eigenvectors are computed.

upper_lower

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

If upper_lower = job::upper, a stores the upper triangular part of A.

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

n

The order of the matrix A (0≤n).

lda

The leading dimension of a.

Throws

onemkl::lapack::exception

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

Return Value

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