hetrd_scratchpad_size¶
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.
hetrd_scratchpad_size¶
Syntax
namespace oneapi::mkl::lapack {
template <typename T>
std::int64_t hetrd_scratchpad_size(cl::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::upperoruplo::lower.If
upper_lower = uplo::upper,astores the upper triangular part of \(A\) and \(B\).If
upper_lower = uplo::lower,astores 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,ldais not referenced in this function.
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::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 hetrd function should be able to hold.
Parent topic: LAPACK Singular Value and Eigenvalue Problem Routines