potrf (USM Version)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 3/22/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-18D42275-5BB5-45FC-B03E-9182EA57D8CF

View Details

potrf (USM Version)

Computes the Cholesky factorization of a symmetric (Hermitian) positive-definite matrix.This routine belongs to the oneapi::mkl::lapack namespace.

Description
API

Description

The routine forms the Cholesky factorization of a symmetric positive-definite or, for complex data, Hermitian positive-definite matrix A:

`A` = `U`^T`U` for real data, `A` = `U`^H`U` for complex data	if uplo=`mkl::uplo::upper`
`A` = `L``L`^T for real data, `A` = `L``L`^H for complex data	if uplo=`mkl::uplo::lower`

where L is a lower triangular matrix and U is upper triangular.

API

Syntax

namespace oneapi::mkl::lapack {
  sycl::event potrf(sycl::queue &queue,
  mkl::uplo uplo,
  std::int64_t n,
  T *a,
  std::int64_t lda,
  T *scratchpad,
  std::int64_t scratchpad_size,
  const std::vector<sycl::event> &events = {})
}

The USM version of potrf supports the following precisions and devices:

T	Devices supported
`float`	CPU and GPU
`double`	CPU and GPU
`std::complex<float>`	CPU and GPU
`std::complex<double>`	CPU and GPU

Input Parameters

queue

Device queue where calculations 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).

a

Pointer to input matrix A. The array holding input matrix a contains either the upper or the lower triangular part of the matrix A (see uplo). The second dimension of a must be at least max(1, n).

lda

The leading dimension of a.

scratchpad

Pointer to scratchpad memory to be used by the routine for storing intermediate results.

scratchpad_size

Size of scratchpad memory as a number of floating point elements of type T. Size should not be less than the value returned by the potrf_scratchpad_size function.

events

List of events to wait for before starting computation. Defaults to empty list.

Output Parameters

a: The memory pointed to by pointer a is overwritten by the Cholesky factor U or L, as specified by uplo.

Exceptions

Exception	Description
`mkl::lapack::exception`	This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the info() method of the exception object: If `info = -i`, the `i`-th parameter had an illegal value. If `info = i`, and detail() returns 0, the leading minor of order `i` (and therefore the matrix `A` itself) is not positive-definite, and the factorization could not be completed. This may indicate an error in forming the matrix `A`. If `info` is equal to the value passed as scratchpad size, and detail() returns non zero, then the passed scratchpad has an insufficient size, and the required size should not be less than the value returned by the detail() method of the exception object.

Exception

Description

mkl::lapack::exception

This exception is thrown when problems occur during calculations. You can obtain the info code of the problem using the info() method of the exception object:

If info = -i, the i-th parameter had an illegal value.

If info = i, and detail() returns 0, the leading minor of order i (and therefore the matrix A itself) is not positive-definite, and the factorization could not be completed. This may indicate an error in forming the matrix A.

If info is equal to the value passed as scratchpad size, and detail() returns non zero, then the passed scratchpad has an insufficient size, and the required size should not be less than the value returned by the detail() method of the exception object.

Return Values

Output event to wait on to ensure computation is complete.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

potrf (USM Version)

Description

API