sytrf_scratchpad_size

Computes size of scratchpad memory required for sytrf function.

Description

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

sytrf_scratchpad_size

Syntax

namespace oneapi::mkl::lapack {
  template <typename T>
  std::int64_t sytrf_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 sytrf function will be performed.

upper_lower

Indicates whether the upper or lower triangular part of \(A\) is stored and how \(A\) is factored:

If upper_lower=uplo::upper, the buffer a stores the upper triangular part of the matrix \(A\), and \(A\) is factored as \(UDU^T\).

If upper_lower=uplo::lower, the buffer a stores the lower triangular part of the matrix \(A\), and \(A\) is factored as \(LDL^T\)

n

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

lda

The leading dimension of a.

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

Parent topic: LAPACK Linear Equation Routines