Ctrl+K

potrf_scratchpad_size

potrf_scratchpad_size#

Computes size of scratchpad memory required for potrf function.

Description

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

potrf_scratchpad_size#

Syntax

namespace oneapi::mkl::lapack {
  template <typename T>
  std::int64_t potrf_scratchpad_size(sycl::queue &queue, oneapi::mkl::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 = oneapi::mkl::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 = oneapi::mkl::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 \le n\)).

lda

The leading dimension of a.

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

Contents