potrf_batch (USM Strided 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-B9989DC6-35B0-49C3-95AE-949AF6B9EC8D

View Details

potrf_batch (USM Strided Version)

Computes the Cholesky factorizations of a batch of symmetric (or Hermitian, for complex data) positive-definite matrices. This routine belongs to the oneapi::mkl::lapack namespace.

Description
API

Description

The routine forms the Cholesky factorizations of a symmetric positive-definite or, for complex data, Hermitian positive-definite matrices A_i, iϵ{1...batch_size}:

A_i = U_i^T * U_i for real data, A_i = U_i^H * U_i for complex data. if uplo = mkl::uplo::upper,
A_i = L_i^T * L_i for real data, A_i = L_i^H * L_i for complex data if uplo = mkl::uplo::lower

Where L_i is a lower triangular matrix and U_i is an upper triangular matrix.

API

Syntax

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

This function 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_i is stored and how A_i is factored:

If uplo = mkl::uplo::upper, the array a stores the upper triangular parts of the matrices A_i.

If uplo = mkl::uplo::lower, the array a stores the lower triangular parts of the matrices A_i.

n

Specifies the order of the matrices A_i, (n ≥ 0).

a

Array containing a batch of input matrices A_i, each of A_i being of size lda*n and holding either upper or lower triangular parts of the matrices A_i (see uplo).

lda

The leading dimension of A_i (lda ≥ max(1, n)).

stride_a

The stride between the beginnings of matrices A_i inside the batch (stride_a ≥ max(1, lda * n)).

batch_size

The number of problems in a batch (batch_size ≥ 0).

scratchpad

Scratchpad memory to be used by 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 then the value returned by potrf_batch_scratchpad_size (Strided Version).

events

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

Output Parameters

a: The batch array a is overwritten by the Cholesky factor U_i or L_i, as specified by uplo .

Exceptions

Exception	Description
`mkl::lapack::batch_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 = -n`, the `n`-th parameter had an illegal value. If `info` equals the value passed as scratchpad size, and detail() returns non-zero, then the passed scratchpad is of insufficient size, and the required size should be not less then value returned by the detail() method of the exception object. If `info` is zero, then the diagonal element of some of `U`_i is zero, and the solve could not be completed. The indexes of such matrices in the batch can be obtained with the `ids()` method of the exception object. You can obtain the indexes of the first zero diagonal elements in these `U`_i matrices using the `infos()` method of the exception object.

Exception

Description

mkl::lapack::batch_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 = -n, the n-th parameter had an illegal value.

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

If info is zero, then the diagonal element of some of U_i is zero, and the solve could not be completed. The indexes of such matrices in the batch can be obtained with the ids() method of the exception object. You can obtain the indexes of the first zero diagonal elements in these U_i matrices using the infos() 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_batch (USM Strided Version)

Description

API