9642ac52a7f398507b441cb01cf20b67a640b6f1
[platform/upstream/armcl.git] / arm_compute / core / NEON / kernels / NEQuantizationLayerKernel.h
1 /*
2  * Copyright (c) 2017-2018 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_NEQUANTIZATIONLAYERKERNEL_H__
25 #define __ARM_COMPUTE_NEQUANTIZATIONLAYERKERNEL_H__
26
27 #include "arm_compute/core/NEON/INEKernel.h"
28
29 namespace arm_compute
30 {
31 class ITensor;
32
33 /** Interface for the quantization layer kernel.
34  *
35  * @note The implementation supports only 3D input tensors
36  *
37  */
38 class NEQuantizationLayerKernel : public INEKernel
39 {
40 public:
41     const char *name() const override
42     {
43         return "NEQuantizationLayerKernel";
44     }
45     /** Default constructor */
46     NEQuantizationLayerKernel();
47     /** Prevent instances of this class from being copied (As this class contains pointers) */
48     NEQuantizationLayerKernel(const NEQuantizationLayerKernel &) = delete;
49     /** Prevent instances of this class from being copied (As this class contains pointers) */
50     NEQuantizationLayerKernel &operator=(const NEQuantizationLayerKernel &) = delete;
51     /** Default Move Constructor. */
52     NEQuantizationLayerKernel(NEQuantizationLayerKernel &&) = default;
53     /** Default move assignment operator. */
54     NEQuantizationLayerKernel &operator=(NEQuantizationLayerKernel &&) = default;
55     /** Default destructor */
56     ~NEQuantizationLayerKernel() = default;
57     /** Set the input, output, min and max.
58      *
59      * @param[in]  input   Source tensor with at least 3 dimensions. The dimensions over the third will be interpreted as batches. Data types supported: F32.
60      * @param[out] output  Destination tensor with the same dimensions of input. Data types supported: U8.
61      * @param[in]  min_max Pointer to the tensor with shape [2, batches] which stores the minimum and maximum value for each 3D input tensor.
62      *                     The dimensions over the second must match the batched dimensions of the input tensor. Data type supported: F32
63      */
64     void configure(const ITensor *input, ITensor *output, const ITensor *min_max);
65
66     // Inherited methods overridden:
67     void run(const Window &window, const ThreadInfo &info) override;
68
69 private:
70     const ITensor *_input;
71     ITensor       *_output;
72     const ITensor *_min_max;
73 };
74 } // namespace arm_compute
75 #endif /*__ARM_COMPUTE_NEQUANTIZATIONLAYERKERNEL_H__ */