ungqr_batch_scratchpad_size
ungqr_batch_scratchpad_size#
Computes size of scratchpad memory required for the ungqr_batch function.
Description
ungqr_batch_scratchpad_size supports the following precisions.
T
std::complex<float>
std::complex<double>
Group API
Computes the number of elements of type T the scratchpad memory should able to hold to be passed to the Group API of the ungqr_batch function.
Syntax
namespace oneapi::mkl::lapack {
template <typename T>
std::int64_t ungqr_batch_scratchpad_size(cl::sycl::queue &queue, std::int64_t *m, std::int64_t *n, std::int64_t *k, std::int64_t *lda, std::int64_t group_count, std::int64_t *group_sizes)
}
Input Parameters
- queue
Device queue where calculations will be performed.
- m
Array of
group_count\(m_g\) parameters.- n
Array of
group_count\(n_g\) parameters.- k
- Array of
group_count\(k_g\) parameters.Number of elementary reflectors whose product defines the matrices \(Q_i\) (\(0 \le k_g \le n_g\)). - lda
Array of leading dimensions of \(A_i\).
- group_count
Number of groups of parameters. Must be at least 0.
- group_sizes
Array of
group_countintegers. Array element with index \(g\) specifies the number of problems to solve for each of the groups of parameters \(g\). So the total number of problems to solve,batch_size, is a sum of all parameter group sizes.
Return Values
Number of elements of type T the scratchpad memory should able to hold to be passed to the Group API of the ungqr_batch function.
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
Exception is thrown in case of incorrect supplied argument value. Position of wrong argument can be determined by info() method of exception object.
Strided API
Computes the number of elements of type T the scratchpad memory should able to hold to be passed to the Strided API of the ungqr_batch function.
Syntax
namespace oneapi::mkl::lapack {
template <typename T>
std::int64_t ungqr_batch_scratchpad_size(cl::sycl::queue &queue, std::int64_t m, std::int64_t n, std::int64_t k, std::int64_t lda, std::int64_t stride_a, std::int64_t stride_tau, std::int64_t batch_size)
};
Input Parameters
- queue
Device queue where calculations will be performed.
- m
Number of rows in the matrices \(A_i\) (\(0 \le m\)).
- n
Number of columns in the matrices \(A_i\) (\(0 \le n\)).
- k
Number of elementary reflectors whose product defines the matrices \(Q_i\) (\(0 \le k \le n\)).
- lda
Leading dimensions of \(A_i\) (\(\text{lda} \le m\)).
- stride_a
Stride between the beginnings of matrices \(A_i\) inside the batch array
a.- stride_tau
Stride between the beginnings of arrays \(\tau_i\) inside the array
tau.- batch_size
Number of problems in a batch.
Return Values
Number of elements of type T the scratchpad memory should able to hold to be passed to the Strided API of the ungqr_batch function.
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
Exception is thrown in case of incorrect supplied argument value. Position of wrong argument can be determined by info() method of exception object.
Parent topic: LAPACK-like Extensions Routines