11571631746

Committed 29 Oct 2024 10:09AM UTC coverage: 63.98% (-0.3%) from 64.241%

Build # 11571631746

Build Type

Pull #2133

github

Committed by

web-flow

Commit Message

Merge c432bab2d into 6ba840a8a

Pull Request Pull Request #2133: Add implementation of `dpnp.sinc` function

Run Details

3689 of 8348 branches covered (44.19%)

Branch coverage included in aggregate %.

27 of 95 new or added lines in 4 files covered. (28.42%)

5 existing lines in 2 files now uncovered.

13807 of 18998 relevant lines covered (72.68%)

17740.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/dpnp/backend/kernels/elementwise_functions/sinc.hpp

//*****************************************************************************
// Copyright (c) 2024, 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.
//
// 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

#define SYCL_EXT_ONEAPI_COMPLEX
#if __has_include(<sycl/ext/oneapi/experimental/sycl_complex.hpp>)
#include <sycl/ext/oneapi/experimental/sycl_complex.hpp>
#else
#include <sycl/ext/oneapi/experimental/complex/complex.hpp>
#endif

#include <sycl/sycl.hpp>

// dpctl tensor headers
#include "utils/type_utils.hpp"

namespace dpnp::kernels::sinc
{
namespace tu_ns = dpctl::tensor::type_utils;

namespace impl
{
namespace exprm_ns = sycl::ext::oneapi::experimental;

template <typename Tp>
inline Tp sin(const Tp &in)
{
    if constexpr (tu_ns::is_complex<Tp>::value) {
        using realTp = typename Tp::value_type;

        constexpr realTp q_nan = std::numeric_limits<realTp>::quiet_NaN();

        realTp const &in_re = std::real(in);
        realTp const &in_im = std::imag(in);

        const bool in_re_finite = sycl::isfinite(in_re);
        const bool in_im_finite = sycl::isfinite(in_im);
        /*
         * Handle the nearly-non-exceptional cases where
         * real and imaginary parts of input are finite.
         */
        if (in_re_finite && in_im_finite) {
            Tp res = exprm_ns::sin(exprm_ns::complex<realTp>(in)); // sin(in);
            if (in_re == realTp(0)) {
                res.real(sycl::copysign(realTp(0), in_re));
            }
            return res;
        }

        /*
         * since sin(in) = -I * sinh(I * in), for special cases,
         * we calculate real and imaginary parts of z = sinh(I * in) and
         * then return { imag(z) , -real(z) } which is sin(in).
         */
        const realTp x = -in_im;
        const realTp y = in_re;
        const bool xfinite = in_im_finite;
        const bool yfinite = in_re_finite;
        /*
         * sinh(+-0 +- I Inf) = sign(d(+-0, dNaN))0 + I dNaN.
         * The sign of 0 in the result is unspecified.  Choice = normally
         * the same as dNaN.
         *
         * sinh(+-0 +- I NaN) = sign(d(+-0, NaN))0 + I d(NaN).
         * The sign of 0 in the result is unspecified.  Choice = normally
         * the same as d(NaN).
         */
        if (x == realTp(0) && !yfinite) {
            const realTp sinh_im = q_nan;
            const realTp sinh_re = sycl::copysign(realTp(0), x * sinh_im);
            return Tp{sinh_im, -sinh_re};
        }

        /*
         * sinh(+-Inf +- I 0) = +-Inf + I +-0.
         *
         * sinh(NaN +- I 0)   = d(NaN) + I +-0.
         */
        if (y == realTp(0) && !xfinite) {
            if (std::isnan(x)) {
                const realTp sinh_re = x;
                const realTp sinh_im = y;
                return Tp{sinh_im, -sinh_re};
            }
            const realTp sinh_re = x;
            const realTp sinh_im = sycl::copysign(realTp(0), y);
            return Tp{sinh_im, -sinh_re};
        }

        /*
         * sinh(x +- I Inf) = dNaN + I dNaN.
         *
         * sinh(x + I NaN) = d(NaN) + I d(NaN).
         */
        if (xfinite && !yfinite) {
            const realTp sinh_re = q_nan;
            const realTp sinh_im = x * sinh_re;
            return Tp{sinh_im, -sinh_re};
        }

        /*
         * sinh(+-Inf + I NaN)  = +-Inf + I d(NaN).
         * The sign of Inf in the result is unspecified.  Choice = normally
         * the same as d(NaN).
         *
         * sinh(+-Inf +- I Inf) = +Inf + I dNaN.
         * The sign of Inf in the result is unspecified.
         * Choice = always - here for sinh to have positive result for
         * imaginary part of sin.
         *
         * sinh(+-Inf + I y)   = +-Inf cos(y) + I Inf sin(y)
         */
        if (std::isinf(x)) {
            if (!yfinite) {
                const realTp sinh_re = -x * x;
                const realTp sinh_im = x * (y - y);
                return Tp{sinh_im, -sinh_re};
            }
            const realTp sinh_re = x * sycl::cos(y);
            const realTp sinh_im =
                std::numeric_limits<realTp>::infinity() * sycl::sin(y);
            return Tp{sinh_im, -sinh_re};
        }

        /*
         * sinh(NaN + I NaN)  = d(NaN) + I d(NaN).
         *
         * sinh(NaN +- I Inf) = d(NaN) + I d(NaN).
         *
         * sinh(NaN + I y)    = d(NaN) + I d(NaN).
         */
        const realTp y_m_y = (y - y);
        const realTp sinh_re = (x * x) * y_m_y;
        const realTp sinh_im = (x + x) * y_m_y;
        return Tp{sinh_im, -sinh_re};
    }
    else {
        if (in == Tp(0)) {
            return in;
        }
        return sycl::sin(in);
    }
}
} // namespace impl

template <typename argT, typename Tp>
struct SincFunctor
{
    // is function constant for given argT
    using is_constant = typename std::false_type;
    // constant value, if constant
    // constexpr Tp constant_value = Tp{};
    // is function defined for sycl::vec
    using supports_vec = typename std::false_type;
    // do both argT and Tp support subgroup store/load operation
    using supports_sg_loadstore = typename std::negation<
        std::disjunction<tu_ns::is_complex<Tp>, tu_ns::is_complex<argT>>>;

    Tp operator()(const argT &x) const
    {
        constexpr argT pi =
            static_cast<argT>(3.1415926535897932384626433832795029L);
        const argT y = pi * x;

        if (y == argT(0)) {
            return Tp(1);
        }

        if constexpr (tu_ns::is_complex<argT>::value) {
            return impl::sin(y) / y;
        }
        else {
            return sycl::sinpi(x) / y;
        }
    }
};
} // namespace dpnp::kernels::sinc

1	//*****************************************************************************
2	// Copyright (c) 2024, 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	//
13	// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14	// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15	// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16	// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
17	// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18	// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19	// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20	// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21	// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22	// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23	// THE POSSIBILITY OF SUCH DAMAGE.
24	//*****************************************************************************
25
26	#pragma once
27
28	#define SYCL_EXT_ONEAPI_COMPLEX
29	#if __has_include(<sycl/ext/oneapi/experimental/sycl_complex.hpp>)
30	#include <sycl/ext/oneapi/experimental/sycl_complex.hpp>
31	#else
32	#include <sycl/ext/oneapi/experimental/complex/complex.hpp>
33	#endif
34
35	#include <sycl/sycl.hpp>
36
37	// dpctl tensor headers
38	#include "utils/type_utils.hpp"
39
40	namespace dpnp::kernels::sinc
41	{
42	namespace tu_ns = dpctl::tensor::type_utils;
43
44	namespace impl
45	{
46	namespace exprm_ns = sycl::ext::oneapi::experimental;
47
48	template <typename Tp>
49	inline Tp sin(const Tp &in)
NEW 50	{	×
NEW 51	if constexpr (tu_ns::is_complex<Tp>::value) {	×
NEW 52	using realTp = typename Tp::value_type;	×
53
NEW 54	constexpr realTp q_nan = std::numeric_limits<realTp>::quiet_NaN();	×
55
NEW 56	realTp const &in_re = std::real(in);	×
NEW 57	realTp const &in_im = std::imag(in);	×
58
NEW 59	const bool in_re_finite = sycl::isfinite(in_re);	×
NEW 60	const bool in_im_finite = sycl::isfinite(in_im);	×
61	/*
62	* Handle the nearly-non-exceptional cases where
63	* real and imaginary parts of input are finite.
64	*/
NEW 65	if (in_re_finite && in_im_finite) {	×
NEW 66	Tp res = exprm_ns::sin(exprm_ns::complex<realTp>(in)); // sin(in);	×
NEW 67	if (in_re == realTp(0)) {	×
NEW 68	res.real(sycl::copysign(realTp(0), in_re));	×
NEW 69	}	×
NEW 70	return res;	×
NEW 71	}	×
72
73	/*
74	* since sin(in) = -I * sinh(I * in), for special cases,
75	* we calculate real and imaginary parts of z = sinh(I * in) and
76	* then return { imag(z) , -real(z) } which is sin(in).
77	*/
NEW 78	const realTp x = -in_im;	×
NEW 79	const realTp y = in_re;	×
NEW 80	const bool xfinite = in_im_finite;	×
NEW 81	const bool yfinite = in_re_finite;	×
82	/*
83	* sinh(+-0 +- I Inf) = sign(d(+-0, dNaN))0 + I dNaN.
84	* The sign of 0 in the result is unspecified. Choice = normally
85	* the same as dNaN.
86	*
87	* sinh(+-0 +- I NaN) = sign(d(+-0, NaN))0 + I d(NaN).
88	* The sign of 0 in the result is unspecified. Choice = normally
89	* the same as d(NaN).
90	*/
NEW 91	if (x == realTp(0) && !yfinite) {	×
NEW 92	const realTp sinh_im = q_nan;	×
NEW 93	const realTp sinh_re = sycl::copysign(realTp(0), x * sinh_im);	×
NEW 94	return Tp{sinh_im, -sinh_re};	×
NEW 95	}	×
96
97	/*
98	* sinh(+-Inf +- I 0) = +-Inf + I +-0.
99	*
100	* sinh(NaN +- I 0) = d(NaN) + I +-0.
101	*/
NEW 102	if (y == realTp(0) && !xfinite) {	×
NEW 103	if (std::isnan(x)) {	×
NEW 104	const realTp sinh_re = x;	×
NEW 105	const realTp sinh_im = y;	×
NEW 106	return Tp{sinh_im, -sinh_re};	×
NEW 107	}	×
NEW 108	const realTp sinh_re = x;	×
NEW 109	const realTp sinh_im = sycl::copysign(realTp(0), y);	×
NEW 110	return Tp{sinh_im, -sinh_re};	×
NEW 111	}	×
112
113	/*
114	* sinh(x +- I Inf) = dNaN + I dNaN.
115	*
116	* sinh(x + I NaN) = d(NaN) + I d(NaN).
117	*/
NEW 118	if (xfinite && !yfinite) {	×
NEW 119	const realTp sinh_re = q_nan;	×
NEW 120	const realTp sinh_im = x * sinh_re;	×
NEW 121	return Tp{sinh_im, -sinh_re};	×
NEW 122	}	×
123
124	/*
125	* sinh(+-Inf + I NaN) = +-Inf + I d(NaN).
126	* The sign of Inf in the result is unspecified. Choice = normally
127	* the same as d(NaN).
128	*
129	* sinh(+-Inf +- I Inf) = +Inf + I dNaN.
130	* The sign of Inf in the result is unspecified.
131	* Choice = always - here for sinh to have positive result for
132	* imaginary part of sin.
133	*
134	* sinh(+-Inf + I y) = +-Inf cos(y) + I Inf sin(y)
135	*/
NEW 136	if (std::isinf(x)) {	×
NEW 137	if (!yfinite) {	×
NEW 138	const realTp sinh_re = -x * x;	×
NEW 139	const realTp sinh_im = x * (y - y);	×
NEW 140	return Tp{sinh_im, -sinh_re};	×
NEW 141	}	×
NEW 142	const realTp sinh_re = x * sycl::cos(y);	×
NEW 143	const realTp sinh_im =	×
NEW 144	std::numeric_limits<realTp>::infinity() * sycl::sin(y);	×
NEW 145	return Tp{sinh_im, -sinh_re};	×
NEW 146	}	×
147
148	/*
149	* sinh(NaN + I NaN) = d(NaN) + I d(NaN).
150	*
151	* sinh(NaN +- I Inf) = d(NaN) + I d(NaN).
152	*
153	* sinh(NaN + I y) = d(NaN) + I d(NaN).
154	*/
NEW 155	const realTp y_m_y = (y - y);	×
NEW 156	const realTp sinh_re = (x * x) * y_m_y;	×
NEW 157	const realTp sinh_im = (x + x) * y_m_y;	×
NEW 158	return Tp{sinh_im, -sinh_re};	×
159	}
160	else {
161	if (in == Tp(0)) {
162	return in;
163	}
164	return sycl::sin(in);
165	}
NEW 166	}	×
167	} // namespace impl
168
169	template <typename argT, typename Tp>
170	struct SincFunctor
171	{
172	// is function constant for given argT
173	using is_constant = typename std::false_type;
174	// constant value, if constant
175	// constexpr Tp constant_value = Tp{};
176	// is function defined for sycl::vec
177	using supports_vec = typename std::false_type;
178	// do both argT and Tp support subgroup store/load operation
179	using supports_sg_loadstore = typename std::negation<
180	std::disjunction<tu_ns::is_complex<Tp>, tu_ns::is_complex<argT>>>;
181
182	Tp operator()(const argT &x) const
NEW 183	{	×
NEW 184	constexpr argT pi =	×
NEW 185	static_cast<argT>(3.1415926535897932384626433832795029L);	×
NEW 186	const argT y = pi * x;	×
187
NEW 188	if (y == argT(0)) {	×
NEW 189	return Tp(1);	×
NEW 190	}	×
191
NEW 192	if constexpr (tu_ns::is_complex<argT>::value) {	×
NEW 193	return impl::sin(y) / y;	×
194	}
NEW 195	else {	×
NEW 196	return sycl::sinpi(x) / y;	×
NEW 197	}	×
NEW 198	}	×
199	};
200	} // namespace dpnp::kernels::sinc

IntelPython / dpnp / 11571631746

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous