orgtr
Contents
orgtr#
Generates the real orthogonal matrix \(Q\) determined by sytrd.
Description
orgtr
supports the following precisions.
T
float
double
The routine explicitly generates the \(n \times n\) orthogonal matrix \(Q\) formed by sytrd when reducing a real symmetric matrix \(A\) to tridiagonal form: \(A = QTQ^T\). Use this routine after a call to sytrd.
orgtr (Buffer Version)#
Syntax
namespace oneapi::mkl::lapack {
void orgtr(cl::sycl::queue &queue, oneapi::mkl::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::upper
oruplo::lower
. Uses the sameupper_lower
as supplied to sytrd.- n
The order of the matrix \(Q\) \((0 \le n)\).
- a
The buffer
a
as returned by sytrd. The second dimension ofa
must be at least \(\max(1,n)\).- lda
The leading dimension of
a
\((n \le \text{lda})\).- tau
The buffer
tau
as returned by sytrd. The dimension oftau
must be at least \(\max(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
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 \(\text{info}=-i\), the \(i\)-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.
orgtr (USM Version)#
Syntax
namespace oneapi::mkl::lapack {
cl::sycl::event orgtr(cl::sycl::queue &queue, oneapi::mkl::uplo upper_lower, std::int64_t n, 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.
- upper_lower
Must be
uplo::upper
oruplo::lower
. Uses the sameupper_lower
as supplied to sytrd.- n
The order of the matrix \(Q\) \((0 \le n)\).
- a
The pointer to
a
as returned by sytrd. The second dimension ofa
must be at least \(\max(1,n)\).- lda
The leading dimension of
a
\((n \le \text{lda})\).- tau
The pointer to
tau
as returned by sytrd. The dimension oftau
must be at least \(\max(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
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 \(\text{info}=-i\), the \(i\)-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