hetrd_scratchpad_size¶

Computes size of scratchpad memory required for hetrd function.

hetrd_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 hetrd function should be able to hold. Calls to this routine must specify the template parameter explicitly.

hetrd_scratchpad_size¶

Syntax

template<typename T> std::int64_t onemkl::lapack::hetrd_scratchpad_size(cl::sycl::queue &queue, onemkl::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≤n).

lda

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

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

Parent topic: LAPACK Singular Value and Eigenvalue Problem Routines