potrs_batch (Buffer Strided Version)

Solves a system of linear equations with a Cholesky-factored symmetric (Hermitian) positive-definite coefficient matrices. This routine belongs to the oneapi::mkl::lapack namespace.

Description

The routine solves for Xi the system of linear equations Ai*Xi = Bi with a symmetric positive-definite or, for complex data, Hermitian positive-definite matrices Ai, given the Cholesky factorization of Ai, i ϵ{1...batch_size} :

  • Ai = UiT*Ui for real data, Ai = UiH*Ui for complex data if uplo=mkl::uplo::upper

  • Ai = Li*LiT for real data, Ai = Li*LiH for complex data if uplo=mkl::uplo::lower

where Li is a lower triangular matrix and Ui is upper triangular. The system is solved with multiple right-hand sides stored in the columns of the matrix Bi.

Before calling this routine, matrices Ai should be factorized by a call to potrf_batch (Buffer Strided Version).

API

Syntax

namespace oneapi::mkl::lapack {
  void potrs_batch(cl::sycl::queue &queue,
  mkl::uplo uplo,
  std::int64_t n,
  std::int64_t nrhs,
  cl::sycl::buffer<T> &a,
  std::int64_t lda,
  std::int64_t stride_a,
  cl::sycl::buffer<T> &b,
  std::int64_t ldb,
  std::int64_t stride_b,
  std::int64_t batch_size,
  cl::sycl::buffer<T> &scratchpad,
  std::int64_t scratchpad_size)
}

Function supports the following precisions and devices.

T

Devices supported

float

Host, CPU, and GPU

double

Host, CPU, and GPU

std::complex<float>

Host, CPU, and GPU

std::complex<double>

Host, CPU, and GPU

Input Parameters

queue

Device queue where calculations will be performed.

uplo

Indicates how the input matrix has been factored:

If uplo=mkl::uplo::upper, the upper triangle Ui of Ai is stored, where Ai = UiT*Ui for real data, Ai = UiH*Ui for complex data.

If uplo=mkl::uplo::lower, the upper triangle Li of Ai is stored, where Ai = Li*LiT for real data, Ai = Li*LiH for complex data.

n

The order of the matrices Ai (0 n).

nrhs

The number of right hand sides (0≤nrhs).

a

Array containing the batch of factorizations of the matrices Ai, as returned by potrf_batch (Buffer Strided Version).

lda

The leading dimension of Ai.

stride_a

The stride between the beginnings of matrices inside the batch array a.

b

The array containing the batch of matrices Bi whose columns are the right-hand sides for the systems of equations.

ldb

The leading dimensions of Bi.

stride_b

The stride between the beginnings of matrices Bi inside the batch array b.

batch_size

Specifies the number of problems in a batch.

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 stride version of potrs_batch_scratchpad_size (Strided Version) function.

Output Parameters

b

The batch array b is overwritten by the solution matrix Xi.

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 Ui 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 Ui matrices using the infos() method of the exception object.