aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/core/NEON/kernels/NEMagnitudePhaseKernel.h
blob: 522ed54f9503cc5dcd46af04e3f465fe0856c420 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
/*
 * Copyright (c) 2016-2018 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef __ARM_COMPUTE_NEMAGNITUDEPHASEKERNEL_H__
#define __ARM_COMPUTE_NEMAGNITUDEPHASEKERNEL_H__

#include "arm_compute/core/NEON/INEKernel.h"
#include "arm_compute/core/Types.h"

namespace arm_compute
{
class ITensor;

/** Template interface for the kernel to compute magnitude and phase */
template <MagnitudeType mag_type, PhaseType phase_type>
class NEMagnitudePhaseKernel : public INEKernel
{
public:
    const char *name() const override
    {
        return "NEMagnitudePhaseKernel";
    }
    /** Default constructor */
    NEMagnitudePhaseKernel();
    /** Destructor */
    ~NEMagnitudePhaseKernel() = default;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    NEMagnitudePhaseKernel(const NEMagnitudePhaseKernel &) = delete;
    /** Default move constructor */
    NEMagnitudePhaseKernel(NEMagnitudePhaseKernel &&) = default;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    NEMagnitudePhaseKernel &operator=(const NEMagnitudePhaseKernel &) = delete;
    /** Default move assignment operator */
    NEMagnitudePhaseKernel &operator=(NEMagnitudePhaseKernel &&) = default;

    /** Initialise the kernel's input, output.
     *
     * @note At least one of out1 or out2 must be set
     *
     * @param[in]  gx        Gradient X tensor. Data type supported: S16.
     * @param[in]  gy        Gradient Y tensor. Data type supported: S16.
     * @param[out] magnitude (Optional) The output tensor - Magnitude. Data type supported: S16.
     * @param[out] phase     (Optional) The output tensor - Phase. Data type supported: U8.
     */
    void configure(const ITensor *gx, const ITensor *gy, ITensor *magnitude, ITensor *phase);

    // Inherited methods overridden:
    void run(const Window &window, const ThreadInfo &info) override;

private:
    /** Function to perform magnitude on the given window
     *
     * @param[in] window Region on which to execute the kernel
     */
    void magnitude(const Window &window);
    /** Function to perform phase on the given window
     *
     * @param[in] window Region on which to execute the kernel
     */
    void phase(const Window &window);
    /** Function to perform magnitude and phase on the given window
     *
     * @param[in] window Region on which to execute the kernel
     */
    void magnitude_phase(const Window &window);

private:
    /** Common signature for all the specialised MagnitudePhase functions
     *
     * @param[in] window Region on which to execute the kernel.
     */
    using MagnitudePhaseFunctionPtr = void (NEMagnitudePhaseKernel::*)(const Window &window);
    /** MagnitudePhase function to use for the particular formats passed to configure() */
    MagnitudePhaseFunctionPtr _func;
    const ITensor            *_gx;        /**< Input gradient X */
    const ITensor            *_gy;        /**< Input gradient Y */
    ITensor                  *_magnitude; /**< Output - Magnitude */
    ITensor                  *_phase;     /**< Output - Phase */
};

#ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
/** Template interface for the kernel to compute magnitude and phase */
template <MagnitudeType mag_type, PhaseType phase_type>
class NEMagnitudePhaseFP16Kernel : public INEKernel
{
public:
    const char *name() const override
    {
        return "NEMagnitudePhaseFP16Kernel";
    }
    /** Default constructor */
    NEMagnitudePhaseFP16Kernel();
    /** Destructor */
    ~NEMagnitudePhaseFP16Kernel() = default;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    NEMagnitudePhaseFP16Kernel(const NEMagnitudePhaseFP16Kernel &) = delete;
    /** Default move constructor */
    NEMagnitudePhaseFP16Kernel(NEMagnitudePhaseFP16Kernel &&) = default;
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    NEMagnitudePhaseFP16Kernel &operator=(const NEMagnitudePhaseFP16Kernel &) = delete;
    /** Default move assignment operator */
    NEMagnitudePhaseFP16Kernel &operator=(NEMagnitudePhaseFP16Kernel &&) = default;

    /** Initialise the kernel's input, output.
     *
     * @note At least one of out1 or out2 must be set
     *
     * @param[in]  gx        Gradient X tensor. Data type supported: S16.
     * @param[in]  gy        Gradient Y tensor. Data type supported: S16.
     * @param[out] magnitude (Optional) The output tensor - Magnitude. Data type supported: S16.
     * @param[out] phase     (Optional) The output tensor - Phase. Data type supported: U8.
     */
    void configure(const ITensor *gx, const ITensor *gy, ITensor *magnitude, ITensor *phase);

    // Inherited methods overridden:
    void run(const Window &window, const ThreadInfo &info) override;

private:
    /** Function to perform magnitude on the given window
     *
     * @param[in] window Region on which to execute the kernel
     */
    void magnitude(const Window &window);
    /** Function to perform phase on the given window
     *
     * @param[in] window Region on which to execute the kernel
     */
    void phase(const Window &window);
    /** Function to perform magnitude and phase on the given window
     *
     * @param[in] window Region on which to execute the kernel
     */
    void magnitude_phase(const Window &window);

    /** Common signature for all the specialised MagnitudePhase functions
     *
     * @param[in] window Region on which to execute the kernel.
     */
    using MagnitudePhaseFunctionPtr = void (NEMagnitudePhaseFP16Kernel::*)(const Window &window);
    /** MagnitudePhase function to use for the particular formats passed to configure() */
    MagnitudePhaseFunctionPtr _func;
    const ITensor            *_gx;        /**< Input gradient X */
    const ITensor            *_gy;        /**< Input gradient Y */
    ITensor                  *_magnitude; /**< Output - Magnitude */
    ITensor                  *_phase;     /**< Output - Phase */
};
#else  /* __ARM_FEATURE_FP16_VECTOR_ARITHMETIC */
template <MagnitudeType mag_type, PhaseType phase_type>
using NEMagnitudePhaseFP16Kernel = NEMagnitudePhaseKernel<mag_type, phase_type>;
#endif /* __ARM_FEATURE_FP16_VECTOR_ARITHMETIC */
} // namespace arm_compute
#endif /* __ARM_COMPUTE_NEMAGNITUDEPHASEKERNEL_H__ */