geqrf_batch (Group Version)
Computes the batch of QR factorizations of a general m-by-n matrices.
This routine belongs to the
oneapi::mkl::lapack
namespace.Description
The routine forms the
Q
i
R
i
factorizations
of a general m
-by-n
matrix A
i
,
iϵ{1...batch_size}
, where batch_size
is a sum of all
parameter group sizes as provided with the group_sizes
array. No
pivoting is performed during factorization.The routine does not form the matrix
Q
i
explicitly.
Instead, Q
i
is represented as a product of min(m
,
n
) elementary reflectors. Routines are provided to work with
Q
i
in this representation.Total number of problems to solve,
batch_size
, is a sum of sizes
of all of the groups of parameters as provided by
group_sizes
array.API
Syntax
namespace oneapi::mkl::lapack {
cl::sycl::event geqrf_batch(cl::sycl::queue &queue,
std::int64_t *m,
std::int64_t *n,
T **a,
std::int64_t *lda,
T **tau,
std::int64_t group_count,
std::int64_t *group_sizes,
T *scratchpad,
std::int64_t scratchpad_size,
const std::vector<cl::sycl::event> &events = {})
}
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.
- m
- Array ofgroup_countparameters mgparameters.Each of mgspecifies the number of rows in the matricesAifrom arraya, belonging to groupg.
- n
- Array ofgroup_countparameters ngparameters.Each of ngspecifies the number of columns in the matricesAifrom arraya, belonging to groupg.
- a
- Array ofbatch_sizepointers to input matricesAi, each being of sizeldag*ng(gis an index of group to whichAibelongs).
- lda
- Array ofgroup_countldagparameters, each representing the leading dimensions of input matricesAi, from arraya, belonging to groupg.
- group_count
- Specifies the number of groups of parameters. Must be at least 0.
- group_sizes
- Array of group_count integers. Array element with indexgspecifies the number of problems to solve for each of the groups of parametersg. So the total number of problems to solve,batch_size, is a sum of all parameter group sizes.
- 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 geqrf_batch_scratchpad_size (Group Version).
- events
- List of events to wait for before starting computation. Defaults to empty list.
Output Parameters
- a
- Matrices pointed to by arrayaare overwritten by the factorization data as follows:The elements on and above the diagonal ofAicontain themin(mg,mng)-by-ngupper trapezoidal matricesRi(Riis upper triangular ifmg≥ng); the elements below the diagonal, with the arraytaui, present the orthogonal matrixQias a rpoduct ofmin(mg,ng)elementary reflectors.Here,gis an index of parameters group corresponding toi-th decomposition.
- tau
- Array of pointers to storetaui, each of sizemg,ng, containing scalars that define elementary reflectors for the matricesQiin its decomposition in a product of elementary reflectors.Here,gis an index of parameters group corresponding toi-th decomposition.
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. |
Return Values
Output event to wait on to ensure computation is complete.