arm_compute/runtime/NEON/functions/NEDequantizationLayer.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_NEDEQUANTIZATIONLAYER_H__
  25 #define __ARM_COMPUTE_NEDEQUANTIZATIONLAYER_H__
  26
  27 #include "arm_compute/runtime/IFunction.h"
  28
  29 #include "arm_compute/core/NEON/kernels/NEDequantizationLayerKernel.h"
  30
  31 #include "arm_compute/core/Types.h"
  32
  33 namespace arm_compute
  34 {
  35 class ITensor;
  36
  37 /** Basic function to simulate a dequantization layer. This function calls the following NEON kernels:
  38  *
  39  * @note The implementation supports only 3D input tensors
  40  *
  41  * -# @ref NEDequantizationLayerKernel
  42  *
  43  */
  44 class NEDequantizationLayer : public IFunction
  45 {
  46 public:
  47     /** Default constructor */
  48     NEDequantizationLayer();
  49     /** Configure the kernel.
  50      *
  51      * @param[in]  input   Source tensor with at least 3 dimensions. The dimensions over the third will be interpreted as batches. Data types supported: U8.
  52      * @param[out] output  Destination tensor with the same dimensions of input. Data type supported: F32.
  53      * @param[in]  min_max Pointer to the tensor with shape [2, batches] which stores the minimum and maximum value for each 3D input tensor.
  54      *                     The dimensions over the second must match the batched dimensions of the input tensor. Data type supported: F32
  55      */
  56     void configure(const ITensor *input, ITensor *output, const ITensor *min_max);
  57     /** Static function to check if given info will lead to a valid configuration of @ref NEDequantizationLayer
  58      *
  59      * @param[in] input   Input tensor info. Data types supported: U8.
  60      * @param[in] output  Output tensor info. Data type supported: F32.
  61      * @param[in] min_max Info for 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      * @return a status
  65      */
  66     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *min_max);
  67
  68     // Inherited methods overridden:
  69     void run() override;
  70
  71 private:
  72     NEDequantizationLayerKernel _dequantize_kernel;
  73 };
  74 }
  75 #endif /* __ARM_COMPUTE_NEDEQUANTIZATIONLAYER_H__ */