orgbr_scratchpad

oneMKL - Data Parallel C++ Developer Reference

Download PDF

ID 772045

Date 6/24/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-54B3E701-D814-4764-AF73-F62564473BDC

View Details

orgbr_scratchpad_size

Computes size of scratchpad memory required for orgbr (USM 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 orgbr (buffer or USM version) function must be able to hold.

API

Syntax

namespace oneapi::mkl::lapack {
  template<typename T>
  int64_t orgbr_scratchpad_size(sycl::queue &queue,
  mkl::generate gen,
  int64_t m,
  int64_t n,
  int64_t k,
  int64_t lda)
}

Input Parameters

queue

Device queue where calculations by the orgbr (buffer or USM version) function will be performed.

gen

Must be generate::q or generate::p.

If gen= generate::q, the routine generates the matrix Q.

If gen= generate::p, the routine generates the matrix P^T.

m

The number of rows in the matrix Q or P^T to be returned (0 ≤ m).

If gen= generate::q, m ≥ n ≥ min(m, k).

If gen= generate::p, n ≥ m ≥ min(n, k).

n

The number of rows in the matrix Q or P^T to be returned (0 ≤ n). See m for constraints.

k

If gen= generate::q, the number of columns in the original m-by-k matrix reduced by gebrd (USM Version).

If gen= generate::p, the number of rows in the original k-by-n matrix reduced by gebrd (USM Version).

lda

The leading dimension of a.

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 orgbr (buffer or USM 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

orgbr_scratchpad_size

Description

API