A newer version of this document is available. Customers should click here to go to the newest version.
potrf_scratchpad_size
Computes size of scratchpad memory required for potrf (USM Version) function. This routine belongs to the oneapi::mkl::lapack namespace.
Description
Computes the number of elements of type T the scratchpad memory to be passed to the potrf (buffer or USM version) function must be able to hold.
API
Syntax
namespace oneapi::mkl::lapack {
  template<typename T>
  std::int64_t potrf_scratchpad_size(sycl::queue &queue,
  mkl::uplo uplo,
  std::int64_t n,
  std::int64_t lda)
} 
    
   Input Parameters
- queue
 -  
     
Device queue where calculations by the potrf (buffer or USM version) function will be performed.
 - uplo
 -  
     
Indicates whether the upper or lower triangular part of A is stored and how A is factored:
If uplo=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 uplo=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 ≤ n).
 - lda
 -  
     
The leading dimension of A.
 
Exceptions
Exception  |  
        Description  |  
       
|---|---|
mkl::lapack::exception  |  
        This exception is thrown when an incorrect argument value is supplied. You can determine the position of the incorrect argument by the info() method of the exception object.  |  
       
Return Values
The number of elements of type T the scratchpad memory to be passed to the potrf (buffer or USM version) function must be able to hold.