|
| 1 | +//***************************************************************************** |
| 2 | +// Copyright (c) 2026, Intel Corporation |
| 3 | +// All rights reserved. |
| 4 | +// |
| 5 | +// Redistribution and use in source and binary forms, with or without |
| 6 | +// modification, are permitted provided that the following conditions are met: |
| 7 | +// - Redistributions of source code must retain the above copyright notice, |
| 8 | +// this list of conditions and the following disclaimer. |
| 9 | +// - Redistributions in binary form must reproduce the above copyright notice, |
| 10 | +// this list of conditions and the following disclaimer in the documentation |
| 11 | +// and/or other materials provided with the distribution. |
| 12 | +// - Neither the name of the copyright holder nor the names of its contributors |
| 13 | +// may be used to endorse or promote products derived from this software |
| 14 | +// without specific prior written permission. |
| 15 | +// |
| 16 | +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 17 | +// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 18 | +// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 19 | +// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 20 | +// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 21 | +// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 22 | +// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 23 | +// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 24 | +// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 25 | +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
| 26 | +// THE POSSIBILITY OF SUCH DAMAGE. |
| 27 | +//***************************************************************************** |
| 28 | +// |
| 29 | +//===---------------------------------------------------------------------===// |
| 30 | +/// |
| 31 | +/// \file |
| 32 | +/// This file defines kernels for elementwise evaluation of SQRT(x) |
| 33 | +/// function that compute a square root. |
| 34 | +//===---------------------------------------------------------------------===// |
| 35 | + |
| 36 | +#pragma once |
| 37 | +#include <complex> |
| 38 | +#include <cstddef> |
| 39 | +#include <cstdint> |
| 40 | +#include <type_traits> |
| 41 | +#include <vector> |
| 42 | + |
| 43 | +#include <sycl/sycl.hpp> |
| 44 | + |
| 45 | +#include "sycl_complex.hpp" |
| 46 | +#include "vec_size_util.hpp" |
| 47 | + |
| 48 | +#include "kernels/dpctl_tensor_types.hpp" |
| 49 | +#include "kernels/elementwise_functions/common.hpp" |
| 50 | + |
| 51 | +#include "utils/type_dispatch_building.hpp" |
| 52 | +#include "utils/type_utils.hpp" |
| 53 | + |
| 54 | +namespace dpctl::tensor::kernels::sqrt |
| 55 | +{ |
| 56 | + |
| 57 | +using dpctl::tensor::ssize_t; |
| 58 | +namespace td_ns = dpctl::tensor::type_dispatch; |
| 59 | + |
| 60 | +using dpctl::tensor::type_utils::is_complex; |
| 61 | + |
| 62 | +template <typename argT, typename resT> |
| 63 | +struct SqrtFunctor |
| 64 | +{ |
| 65 | + |
| 66 | + // is function constant for given argT |
| 67 | + using is_constant = typename std::false_type; |
| 68 | + // constant value, if constant |
| 69 | + // constexpr resT constant_value = resT{}; |
| 70 | + // is function defined for sycl::vec |
| 71 | + using supports_vec = typename std::false_type; |
| 72 | + // do both argTy and resTy support sugroup store/load operation |
| 73 | + using supports_sg_loadstore = typename std::negation< |
| 74 | + std::disjunction<is_complex<resT>, is_complex<argT>>>; |
| 75 | + |
| 76 | + resT operator()(const argT &in) const |
| 77 | + { |
| 78 | + if constexpr (is_complex<argT>::value) { |
| 79 | + using realT = typename argT::value_type; |
| 80 | + return exprm_ns::sqrt(exprm_ns::complex<realT>(in)); |
| 81 | + } |
| 82 | + else { |
| 83 | + return sycl::sqrt(in); |
| 84 | + } |
| 85 | + } |
| 86 | +}; |
| 87 | + |
| 88 | +template <typename argTy, |
| 89 | + typename resTy = argTy, |
| 90 | + std::uint8_t vec_sz = 4u, |
| 91 | + std::uint8_t n_vecs = 2u, |
| 92 | + bool enable_sg_loadstore = true> |
| 93 | +using SqrtContigFunctor = |
| 94 | + elementwise_common::UnaryContigFunctor<argTy, |
| 95 | + resTy, |
| 96 | + SqrtFunctor<argTy, resTy>, |
| 97 | + vec_sz, |
| 98 | + n_vecs, |
| 99 | + enable_sg_loadstore>; |
| 100 | + |
| 101 | +template <typename argTy, typename resTy, typename IndexerT> |
| 102 | +using SqrtStridedFunctor = elementwise_common:: |
| 103 | + UnaryStridedFunctor<argTy, resTy, IndexerT, SqrtFunctor<argTy, resTy>>; |
| 104 | + |
| 105 | +template <typename T> |
| 106 | +struct SqrtOutputType |
| 107 | +{ |
| 108 | + using value_type = typename std::disjunction< |
| 109 | + td_ns::TypeMapResultEntry<T, sycl::half, sycl::half>, |
| 110 | + td_ns::TypeMapResultEntry<T, float, float>, |
| 111 | + td_ns::TypeMapResultEntry<T, double, double>, |
| 112 | + td_ns::TypeMapResultEntry<T, std::complex<float>, std::complex<float>>, |
| 113 | + td_ns:: |
| 114 | + TypeMapResultEntry<T, std::complex<double>, std::complex<double>>, |
| 115 | + td_ns::DefaultResultEntry<void>>::result_type; |
| 116 | + |
| 117 | + static constexpr bool is_defined = !std::is_same_v<value_type, void>; |
| 118 | +}; |
| 119 | + |
| 120 | +namespace hyperparam_detail |
| 121 | +{ |
| 122 | + |
| 123 | +namespace vsu_ns = dpctl::tensor::kernels::vec_size_utils; |
| 124 | + |
| 125 | +using vsu_ns::ContigHyperparameterSetDefault; |
| 126 | +using vsu_ns::UnaryContigHyperparameterSetEntry; |
| 127 | + |
| 128 | +template <typename argTy> |
| 129 | +struct SqrtContigHyperparameterSet |
| 130 | +{ |
| 131 | + using value_type = |
| 132 | + typename std::disjunction<ContigHyperparameterSetDefault<4u, 2u>>; |
| 133 | + |
| 134 | + constexpr static auto vec_sz = value_type::vec_sz; |
| 135 | + constexpr static auto n_vecs = value_type::n_vecs; |
| 136 | +}; |
| 137 | + |
| 138 | +} // end of namespace hyperparam_detail |
| 139 | + |
| 140 | +template <typename T1, typename T2, std::uint8_t vec_sz, std::uint8_t n_vecs> |
| 141 | +class sqrt_contig_kernel; |
| 142 | + |
| 143 | +template <typename argTy> |
| 144 | +sycl::event sqrt_contig_impl(sycl::queue &exec_q, |
| 145 | + std::size_t nelems, |
| 146 | + const char *arg_p, |
| 147 | + char *res_p, |
| 148 | + const std::vector<sycl::event> &depends = {}) |
| 149 | +{ |
| 150 | + using SqrtHS = hyperparam_detail::SqrtContigHyperparameterSet<argTy>; |
| 151 | + static constexpr std::uint8_t vec_sz = SqrtHS::vec_sz; |
| 152 | + static constexpr std::uint8_t n_vecs = SqrtHS::n_vecs; |
| 153 | + |
| 154 | + return elementwise_common::unary_contig_impl< |
| 155 | + argTy, SqrtOutputType, SqrtContigFunctor, sqrt_contig_kernel, vec_sz, |
| 156 | + n_vecs>(exec_q, nelems, arg_p, res_p, depends); |
| 157 | +} |
| 158 | + |
| 159 | +template <typename fnT, typename T> |
| 160 | +struct SqrtContigFactory |
| 161 | +{ |
| 162 | + fnT get() |
| 163 | + { |
| 164 | + if constexpr (!SqrtOutputType<T>::is_defined) { |
| 165 | + fnT fn = nullptr; |
| 166 | + return fn; |
| 167 | + } |
| 168 | + else { |
| 169 | + fnT fn = sqrt_contig_impl<T>; |
| 170 | + return fn; |
| 171 | + } |
| 172 | + } |
| 173 | +}; |
| 174 | + |
| 175 | +template <typename fnT, typename T> |
| 176 | +struct SqrtTypeMapFactory |
| 177 | +{ |
| 178 | + /*! @brief get typeid for output type of std::sqrt(T x) */ |
| 179 | + std::enable_if_t<std::is_same<fnT, int>::value, int> get() |
| 180 | + { |
| 181 | + using rT = typename SqrtOutputType<T>::value_type; |
| 182 | + return td_ns::GetTypeid<rT>{}.get(); |
| 183 | + } |
| 184 | +}; |
| 185 | + |
| 186 | +template <typename T1, typename T2, typename T3> |
| 187 | +class sqrt_strided_kernel; |
| 188 | + |
| 189 | +template <typename argTy> |
| 190 | +sycl::event |
| 191 | + sqrt_strided_impl(sycl::queue &exec_q, |
| 192 | + std::size_t nelems, |
| 193 | + int nd, |
| 194 | + const ssize_t *shape_and_strides, |
| 195 | + const char *arg_p, |
| 196 | + ssize_t arg_offset, |
| 197 | + char *res_p, |
| 198 | + ssize_t res_offset, |
| 199 | + const std::vector<sycl::event> &depends, |
| 200 | + const std::vector<sycl::event> &additional_depends) |
| 201 | +{ |
| 202 | + return elementwise_common::unary_strided_impl< |
| 203 | + argTy, SqrtOutputType, SqrtStridedFunctor, sqrt_strided_kernel>( |
| 204 | + exec_q, nelems, nd, shape_and_strides, arg_p, arg_offset, res_p, |
| 205 | + res_offset, depends, additional_depends); |
| 206 | +} |
| 207 | + |
| 208 | +template <typename fnT, typename T> |
| 209 | +struct SqrtStridedFactory |
| 210 | +{ |
| 211 | + fnT get() |
| 212 | + { |
| 213 | + if constexpr (!SqrtOutputType<T>::is_defined) { |
| 214 | + fnT fn = nullptr; |
| 215 | + return fn; |
| 216 | + } |
| 217 | + else { |
| 218 | + fnT fn = sqrt_strided_impl<T>; |
| 219 | + return fn; |
| 220 | + } |
| 221 | + } |
| 222 | +}; |
| 223 | + |
| 224 | +} // namespace dpctl::tensor::kernels::sqrt |
0 commit comments