orgtr¶
Generates the real orthogonal matrix Q determined by sytrd.
orgtrsupports the following precisions.
T
float
double
Description
The routine explicitly generates the n-by-n orthogonal matrix
Q formed by
sytrd when
reducing a real symmetric matrix A to tridiagonal form:
A = Q*T*QT. Use this routine after a call to
sytrd.
orgtr (BUFFER Version)¶
Syntax
-
void
onemkl::lapack::orgtr(cl::sycl::queue &queue, onemkl::uplo upper_lower, std::int64_t n, 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.
- upper_lower
Must be
uplo::upperoruplo::lower. Uses the sameupper_loweras supplied to sytrd.- n
The order of the matrix
Q(0≤n).- a
The buffer
aas returned by sytrd. The second dimension of a must be at leastmax(1,n).- lda
The leading dimension of a
(n≤lda).- tau
The buffer
tauas returned by sytrd. The dimension of tau must be at leastmax(1, n-1).- scratchpad_size
Size of scratchpad memory as a number of floating point elements of type T. Size should not be less than the value returned by orgtr_scratchpad_size function.
Output Parameters
- a
Overwritten by the orthogonal matrix
Q.- scratchpad
Buffer holding scratchpad memory to be used by routine for storing intermediate results.
Throws
- onemkl::lapack::exception
Exception is thrown in case of problems happened during calculations. The
infocode of the problem can be obtained by get_info() method of exception object:If
info=-i, thei-th parameter had an illegal value.If
infoequals to value passed as scratchpad size, andget_detail()returns non zero, then passed scratchpad is of insufficient size, and required size should not be less than value return byget_detail()method of exception object.
orgtr (USM Version)¶
Syntax
-
cl::sycl::event
onemkl::lapack::orgtr(cl::sycl::queue &queue, onemkl::uplo upper_lower, std::int64_t n, T *a, std::int64_t lda, T *tau, T *scratchpad, std::int64_t scratchpad_size, const cl::sycl::vector_class<cl::sycl::event> &events = {})¶
Input Parameters
- queue
The queue where the routine should be executed.
- upper_lower
Must be
uplo::upperoruplo::lower. Uses the sameupper_loweras supplied to sytrd.- n
The order of the matrix
Q(0≤n).- a
The pointer to
aas returned by sytrd. The second dimension of a must be at leastmax(1,n).- lda
The leading dimension of a
(n≤lda).- tau
The pointer to
tauas returned by sytrd. The dimension of tau must be at leastmax(1, n-1).- scratchpad_size
Size of scratchpad memory as a number of floating point elements of type T. Size should not be less than the value returned by orgtr_scratchpad_size function.
- events
List of events to wait for before starting computation. Defaults to empty list.
Output Parameters
- a
Overwritten by the orthogonal matrix
Q.- scratchpad
Pointer to scratchpad memory to be used by routine for storing intermediate results.
Throws
- onemkl::lapack::exception
Exception is thrown in case of problems happened during calculations. The
infocode of the problem can be obtained by get_info() method of exception object:If
info=-i, thei-th parameter had an illegal value.If
infoequals to value passed as scratchpad size, andget_detail()returns non zero, then passed scratchpad is of insufficient size, and required size should not be less than value return byget_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