ungbr
Contents
ungbr#
Generates the complex unitary matrix
Description
ungbr
supports the following precisions.
T
std::complex<float>
std::complex<double>
The routine generates the whole or part of the unitary matrices
To compute the whole
oneapi::mkl::lapack::ungbr(queue, generate::q, m, m, n, a, ...)
(note that the buffer a
must have at least
To form the
oneapi::mkl::lapack::ungbr(queue, generate::q, m, n, n, a, ...)
To compute the whole
oneapi::mkl::lapack::ungbr(queue, generate::p, n, n, m, a, ...)
(note that the array a
must have at least
To form the
oneapi::mkl::lapack::ungbr(queue, generate::p, m, n, m, a, ...)
ungbr (Buffer Version)#
Syntax
namespace oneapi::mkl::lapack {
void ungbr(cl::sycl::queue &queue, oneapi::mkl::generate gen, std::int64_t m, std::int64_t n, std::int64_t k, cl::sycl::buffer<T,1> &a, std::int64_t lda, cl::sycl::buffer<T,1> &tau, cl::sycl::buffer<T,1> &scratchpad, std::int64_t scratchpad_size)
}
Input Parameters
- queue
The queue where the routine should be executed.
- gen
Must be
generate::q
orgenerate::p
.If
gen = generate::q
, the routine generates the matrix .If
gen = generate::p
, the routine generates the matrix .- m
The number of rows in the matrix
or to be returned .If
gen = generate::q
, .If
gen = generate::p
, .- n
The number of columns in the matrix
or to be returned . Seem
for constraints.- k
If
gen = generate::q
, the number of columns in the original matrix returned by gebrd.If
gen = generate::p
, the number of rows in the original matrix returned by gebrd.- a
The buffer
a
as returned by gebrd.- lda
The leading dimension of
a
.- tau
For
gen = generate::q
, the arraytauq
as returned by gebrd. Forgen = generate::p
, the arraytaup
as returned by gebrd.The dimension of
tau
must be at least forgen = generate::q
, or forgen = generate::p
.- scratchpad_size
Size of scratchpad memory as a number of floating point elements of type
. Size should not be less than the value returned by ungbr_scratchpad_size function.
Output Parameters
- a
Overwritten by
leading columns of the unitary matrix or , (or the leading rows or columns thereof) as specified bygen
,m
, andn
.- scratchpad
Buffer holding scratchpad memory to be used by routine for storing intermediate results.
Throws
This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.
oneapi::mkl::unsupported_device
oneapi::mkl::lapack::invalid_argument
oneapi::mkl::lapack::computation_error
Exception is thrown in case of problems during calculations. The
info
code of the problem can be obtained by info() method of exception object:If
, the -th parameter had an illegal value. If
info
equals to value passed as scratchpad size, and detail() returns non zero, then passed scratchpad is of insufficient size, and required size should not be less than value return by detail() method of exception object.
ungbr (USM Version)#
Syntax
namespace oneapi::mkl::lapack {
cl::sycl::event ungbr(cl::sycl::queue &queue, oneapi::mkl::generate gen, std::int64_t m, std::int64_t n, std::int64_t k, T *a, std::int64_t lda, T *tau, T *scratchpad, std::int64_t scratchpad_size, const std::vector<cl::sycl::event> &events = {})
}
Input Parameters
- queue
The queue where the routine should be executed.
- gen
Must be
generate::q
orgenerate::p
.If
gen = generate::q
, the routine generates the matrix .If
gen = generate::p
, the routine generates the matrix .- m
The number of rows in the matrix
or to be returned .If
gen = generate::q
, .If
gen = generate::p
, .- n
The number of columns in the matrix
or to be returned . Seem
for constraints.- k
If
gen = generate::q
, the number of columns in the original matrix returned by gebrd.If
gen = generate::p
, the number of rows in the original matrix returned by gebrd.- a
The pointer to
a
as returned by gebrd.- lda
The leading dimension of
a
.- tau
For
gen = generate::q
, the arraytauq
as returned by gebrd. Forgen = generate::p
, the arraytaup
as returned by gebrd.The dimension of
tau
must be at least forgen = generate::q
, or forgen = generate::p
.- scratchpad_size
Size of scratchpad memory as a number of floating point elements of type
. Size should not be less than the value returned by ungbr_scratchpad_size function.- events
List of events to wait for before starting computation. Defaults to empty list.
Output Parameters
- a
Overwritten by
leading columns of the unitary matrix or , (or the leading rows or columns thereof) as specified bygen
,m
, andn
.- scratchpad
Pointer to scratchpad memory to be used by routine for storing intermediate results.
Throws
This routine shall throw the following exceptions if the associated condition is detected. An implementation may throw additional implementation-specific exception(s) in case of error conditions not covered here.
oneapi::mkl::unsupported_device
oneapi::mkl::lapack::invalid_argument
oneapi::mkl::lapack::computation_error
Exception is thrown in case of problems during calculations. The
info
code of the problem can be obtained by info() method of exception object:If
, the -th parameter had an illegal value. If
info
equals to value passed as scratchpad size, and detail() returns non zero, then passed scratchpad is of insufficient size, and required size should not be less than value return by detail() method of exception object.
Return Values
Output event to wait on to ensure computation is complete.
Parent topic: LAPACK Singular Value and Eigenvalue Problem Routines