• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2016-2020 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CLPHASE_H
25 #define ARM_COMPUTE_CLPHASE_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 
35 /** Basic function to execute an @ref CLMagnitudePhaseKernel.
36  *
37  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
38  *
39 */
40 class CLPhase : public ICLSimpleFunction
41 {
42 public:
43     /** Initialise the kernel's inputs, output.
44      *
45      * @param[in]  input1     First tensor input. Data types supported: S16.
46      * @param[in]  input2     Second tensor input. Data types supported: S16.
47      * @param[out] output     Output tensor. Data types supported: U8.
48      * @param[in]  phase_type (Optional) Phase calculation type. Default: SIGNED.
49      */
50     void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, PhaseType phase_type = PhaseType::SIGNED);
51     /** Initialise the kernel's inputs, output.
52      *
53      * @param[in]  compile_context The compile context to be used.
54      * @param[in]  input1          First tensor input. Data types supported: S16.
55      * @param[in]  input2          Second tensor input. Data types supported: S16.
56      * @param[out] output          Output tensor. Data types supported: U8.
57      * @param[in]  phase_type      (Optional) Phase calculation type. Default: SIGNED.
58      */
59     void configure(const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, PhaseType phase_type = PhaseType::SIGNED);
60 };
61 }
62 #endif /*ARM_COMPUTE_CLPHASE_H */
63