Compute Library
 21.02
NEMagnitude.h
Go to the documentation of this file.
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_NEMAGNITUDE_H
25 #define ARM_COMPUTE_NEMAGNITUDE_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 
34 /** Basic function to run @ref NEMagnitudePhaseKernel
35  *
36  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
37  *
38  */
40 {
41 public:
42  /** Constructor */
43  NEMagnitude() = default;
44  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  NEMagnitude(const NEMagnitude &) = delete;
46  /** Prevent instances of this class from being copied (As this class contains pointers) */
47  NEMagnitude &operator=(const NEMagnitude &) = delete;
48  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
49  NEMagnitude(NEMagnitude &&) = delete;
50  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
51  NEMagnitude &operator=(NEMagnitude &&) = delete;
52  /** Default destructor */
53  ~NEMagnitude();
54  /** Initialise the kernel's inputs.
55  *
56  * @param[in] input1 First tensor input. Data type supported: S16.
57  * @param[in] input2 Second tensor input. Data type supported: S16.
58  * @param[out] output Output tensor. Data type supported: S16.
59  * @param[in] mag_type (Optional) Magnitude calculation type. Default: L2NORM.
60  */
61  void configure(const ITensor *input1, const ITensor *input2, ITensor *output, MagnitudeType mag_type = MagnitudeType::L2NORM);
62 };
63 } // namespace arm_compute
64 #endif /*ARM_COMPUTE_NEMAGNITUDE_H */
NEMagnitude()=default
Constructor.
Interface for Neon tensor.
Definition: ITensor.h:36
~NEMagnitude()
Default destructor.
Copyright (c) 2017-2021 Arm Limited.
Basic interface for functions which have a single Neon kernel and no border.
NEMagnitude & operator=(const NEMagnitude &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to run NEMagnitudePhaseKernel.
Definition: NEMagnitude.h:39
L2 normalization type.
void configure(const ITensor *input1, const ITensor *input2, ITensor *output, MagnitudeType mag_type=MagnitudeType::L2NORM)
Initialise the kernel's inputs.
Definition: NEMagnitude.cpp:35
MagnitudeType
Magnitude calculation type.
Definition: Types.h:422