getrf_batch_scratchpad_size (Group Version)

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 11/07/2023

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-A07F64BA-08D3-46D2-A6B4-4E5BDAF1C1A4

View Details

getrf_batch_scratchpad_size (Group Version)

Computes size of scratchpad memory required for getrf_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 getrf_batch (Group Version) function should be able to hold.

API

Syntax

namespace oneapi::mkl::lapack {
  std::int64_t getrf_batch_scratchpad_size(sycl::queue &queue,
  std::int64_t *m,
  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.
m: Array of group_count parameters m_g specifying the number of rows in the matrices belonging to group g (m_g ≥ 0).
n: Array of group_count parameters n_g specifying the number of columns in the matrices belonging to group g (n_g ≥ 0).
lda: Array of group_count parameters lda_g specifying the leading dimension of the matrices belonging to group g (lda_g ≥ max(1, m_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 getrf_batch (Group Version) function should 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

getrf_batch_scratchpad_size (Group Version)

Description

API