gesvd.hpp

//*****************************************************************************
// Copyright (c) 2023, Intel Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// - Redistributions of source code must retain the above copyright notice,
//   this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
// - Neither the name of the copyright holder nor the names of its contributors
//   may be used to endorse or promote products derived from this software
//   without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//*****************************************************************************
 
#pragma once
 
#include <oneapi/mkl.hpp>
#include <sycl/sycl.hpp>
 
#include <dpctl4pybind11.hpp>
 
namespace dpnp::extensions::lapack
{
extern std::pair<sycl::event, sycl::event>
    gesvd(sycl::queue &exec_q,
          const std::int8_t jobu_val,
          const std::int8_t jobvt_val,
          const dpctl::tensor::usm_ndarray &a_array,
          const dpctl::tensor::usm_ndarray &out_s,
          const dpctl::tensor::usm_ndarray &out_u,
          const dpctl::tensor::usm_ndarray &out_vt,
          const std::vector<sycl::event> &depends);
 
extern std::pair<sycl::event, sycl::event>
    gesvd_batch(sycl::queue &exec_q,
                const std::int8_t jobu_val,
                const std::int8_t jobvt_val,
                const dpctl::tensor::usm_ndarray &a_array,
                const dpctl::tensor::usm_ndarray &out_s,
                const dpctl::tensor::usm_ndarray &out_u,
                const dpctl::tensor::usm_ndarray &out_vt,
                const std::vector<sycl::event> &depends);
 
extern void init_gesvd_dispatch_table(void);
extern void init_gesvd_batch_dispatch_table(void);
} // namespace dpnp::extensions::lapack