potrf_batch_scratchpad_size (Group Version)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 7/13/2023

Version

Public

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

potrf_batch_scratchpad_size (Group Version)

Computes the size of scratchpad memory required for potrf_batch (Group Version) function. This routine belongs to the oneapi::mkl::lapack namespace.

Description
API

Description

Computes the number of elements of type T the scratchpad memory to be passed to the potrf_batch (Group Version) function must be able to hold.

API

Syntax

namespace oneapi::mkl::lapack {
  std::int64_t potrf_batch_scratchpad_size(sycl::queue &queue,
  mkl::uplo *uplo,
  std::int64_t *n,
  std::int64_t *lda,
  std::int64_t group_count,
  std::int64_t *group_sizes)
}

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

Array of group_count parameters uplo_g.

Each of uplo_g indicates whether the upper or lower triangular parts of the input matrices are provided.

If uplo_g=mkl::uplo::upper, input matrices from array a belonging to group g store the upper triangular parts.

If uplo_g=mkl::uplo::lower, input matrices from array a belonging to group g store the lower triangular parts.

n

Array of group_countn_g parameters.

Each n_g specifies the order of the input matrices belonging to group g (n_g ≥ 0).

lda

Array of group_count parameters lda_g.

Each lda_g specifies the leading dimension of the matrices belonging to group g (lda_g ≥ max(1, n_g)).

group_count

Specifies the number of groups of parameters. Must be at least 0.

group_sizes

Array of group_count integers. Array element with index g specifies the number of problems to solve for each of the groups of parameters g. So the total number of problems to solve, batch_size, is a sum of all parameter group sizes.

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_batch (Group Version) function must be able to hold.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

oneMKL - Data Parallel C++ Developer Reference

potrf_batch_scratchpad_size (Group Version)

Description

API