potrf_scratchpad_size¶

Computes size of scratchpad memory required for potrf function.

potrf_scratchpad_size supports the following precisions.

T

float

double

std::complex<float>

std::complex<double>

Description

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

potrf_scratchpad_size¶

Syntax

template<typename T> std::int64_t onemkl::lapack::potrf_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 potrf 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=onemkl::uplo::upper, the array a stores the upper triangular part of the matrix A, and the strictly lower triangular part of the matrix is not referenced.

If upper_lower=onemkl::uplo::lower, the array a stores the lower triangular part of the matrix A, and the strictly upper triangular part of the matrix is not referenced.

n

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

Parent topic: LAPACK Linear Equation Routines