gels_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-E87F5204-00FC-41D5-98FE-CB24C01387AF

View Details

gels_scratchpad_size

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

API

Syntax

namespace oneapi::mkl::lapack {
   template<typename T>
   std::int64_t gels_scratchpad_size(sycl::queue &queue,
   mkl::transpose trans,
   std::int64_t m,
   std::int64_t n,
   std::int64_t nrhs,
   std::int64_t lda,
   std::int64_t ldb)
}

Input Parameters

queue

Device queue where calculations by the gels (USM version) function will be performed.

trans

If trans=mkl::transpose::trans, the routine finds the minimum norm solution the underdetermined system A^T*X``=``B.

If trans=mkl::transpose::conjtrans, the routine finds the minimum norm solution the underdetermined system A^H*X``=``B.

If trans=mkl::transpose::nontrans, the routine solves the least squares problem minimize || B - A*X ||.

m

The number of rows in the matrix A (m ≥ 0).

n

The number of columns in the matrix A (n ≥ 0).

nrhs

The number of right hand sides, i.e. the columns of b (nrhs ≥ 0)

lda

The leading dimension of a (lda ≥ max(1,m)).

ldb

The leading dimension of b (ldb ≥ max(1, max(m,n))).

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 gels (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

gels_scratchpad_size

Description

API