.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation .. .. SPDX-License-Identifier: CC-BY-4.0 .. _onemkl_lapack_unmqr_scratchpad_size: unmqr_scratchpad_size ===================== Computes size of scratchpad memory required for :ref:`onemkl_lapack_unmqr` function. .. container:: section .. rubric:: Description ``unmqr_scratchpad_size`` supports the following precisions. .. list-table:: :header-rows: 1 * - T * - ``std::complex`` * - ``std::complex`` Computes the number of elements of type ``T`` the scratchpad memory to be passed to :ref:`onemkl_lapack_unmqr` function should be able to hold. Calls to this routine must specify the template parameter explicitly. unmqr_scratchpad_size --------------------- .. container:: section .. rubric:: Syntax .. code-block:: cpp namespace oneapi::mkl::lapack { template std::int64_t unmqr_scratchpad_size(cl::sycl::queue &queue, oneapi::mkl::side side, oneapi::mkl::transpose trans, std::int64_t m, std::int64_t n, std::int64_t k, std::int64_t lda, std::int64_t ldc, std::int64_t &scratchpad_size) } .. container:: section .. rubric:: Input Parameters queue Device queue where calculations by :ref:`onemkl_lapack_unmqr` function will be performed. side If ``side=oneapi::mkl::side::left``, :math:`Q` or :math:`Q^{H}` is applied to :math:`C` from the left. If ``side=oneapi::mkl::side::right``, :math:`Q` or :math:`Q^{H}` is applied to :math:`C` from the right. trans If ``trans=oneapi::mkl::transpose::nontrans``, the routine multiplies :math:`C` by :math:`Q`. If ``trans=oneapi::mkl::transpose::conjtrans``, the routine multiplies :math:`C` by :math:`Q^H`. m The number of rows in the matrix :math:`C` (:math:`0 \le m`). n The number of columns the matrix :math:`C` (:math:`0 \le n \le m`). k The number of elementary reflectors whose product defines the matrix :math:`Q` (:math:`0 \le k \le n`). lda The leading dimension of ``a``. ldc The leading dimension of ``c``. .. container:: section .. rubric:: 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. :ref:`oneapi::mkl::unimplemented` :ref:`oneapi::mkl::unsupported_device` :ref:`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. .. container:: section .. rubric:: Return Value The number of elements of type ``T`` the scratchpad memory to be passed to :ref:`onemkl_lapack_unmqr` function should be able to hold. **Parent topic:** :ref:`onemkl_lapack-linear-equation-routines`