arm_compute/core/NEON/kernels/NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel.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_NEGEMMLOWPQUANTIZEDOWNINT32TOUINT8SCALEKERNEL_H__
  25 #define __ARM_COMPUTE_NEGEMMLOWPQUANTIZEDOWNINT32TOUINT8SCALEKERNEL_H__
  26
  27 #include "arm_compute/core/NEON/INEKernel.h"
  28
  29 namespace arm_compute
  30 {
  31 class ITensor;
  32
  33 /** NEON kernel used to quantize down the int32 accumulator values of GEMMLowp to QASYMM8
  34  *
  35  * This kernel takes a final int32 accumulator value (the output of @ref NEGEMMLowpMatrixMultiplyKernel), and processes it to obtain the final QASYMM8 value.
  36  * The following computations will be performed by the kernel:
  37  *
  38  *  -# Add offset terms to final result
  39  *  -# Multiply each entry of result by result_mult_int
  40  *  -# Add bias to final result if bias tensor is not a nullptr
  41  *  -# Shift the int32 accumulator by result_shift
  42  *  -# Clamp the value between the specified min and max bounds
  43  *  -# Clamp the resulting int32 values to the [0..255] range and cast to QASYMM8.
  44  *
  45  */
  46 class NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel : public INEKernel
  47 {
  48 public:
  49     const char *name() const override
  50     {
  51         return "NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel";
  52     }
  53     /** Constructor */
  54     NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel();
  55     /** Prevent instances of this class from being copied (As this class contains pointers)*/
  56     NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel(const NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel &) = delete;
  57     /** Prevent instances of this class from being copied (As this class contains pointers)*/
  58     NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel &operator=(const NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel &) = delete;
  59     /** Allow instances of this class to be moved */
  60     NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel(NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel &&) = default;
  61     /** Allow instances of this class to be moved */
  62     NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel &operator=(NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel &&) = default;
  63     /** Initialise the kernel's input and output.
  64      *
  65      * @param[in]  input           Input tensor. Data type supported: S32
  66      * @param[in]  bias            Biases tensor. Only shared biases supported and it can be a nullptr if the biases addition is not required.
  67      *                             Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input.
  68      * @param[out] output          Output tensor. Data type supported: Data type supported: QASYMM8
  69      * @param[in]  result_offset   Offset to be added to each element of the input matrix
  70      * @param[in]  result_mult_int Value to be multiplied to each element of the input matrix when once the result_offset has been add
  71      * @param[in]  result_shift    Number of bits to shift right the result before converting back to QASYMM8
  72      * @param[in]  min             (Optional) Min value used to saturate down the output result before converting back to QASYMM8
  73      * @param[in]  max             (Optional) Max value used to saturate up the output result before converting back to QASYMM8,
  74      *                             Along with @p min, this value can be used to implement "rectified linear unit" activation functions
  75      */
  76     void configure(const ITensor *input, const ITensor *bias, ITensor *output, int result_offset, int result_mult_int, int result_shift, int min = 0, int max = 0);
  77     /** Static function to check if given info will lead to a valid configuration of @ref NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel
  78      *
  79      * @param[in] input  Input tensor. Data type supported: S32
  80      * @param[in] bias   Biases tensor. Only shared biases supported and it can be a nullptr if the biases addition is not required.
  81      *                   Biases are 1D tensor with dimensions [OFM]. Data type supported: Same as @p input.
  82      * @param[in] output Output tensor. Data type supported: Data type supported: QASYMM8
  83      * @param[in] min    (Optional) Min value used to saturate down the output result before converting back to QASYMM8
  84      * @param[in] max    (Optional) Max value used to saturate up the output result before converting back to QASYMM8,
  85      *                   Along with @p min, this value can be used to implement "rectified linear unit" activation functions
  86      *
  87      * @return a status
  88      */
  89     static Status validate(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, int min = 0, int max = 0);
  90
  91     // Inherited methods overridden:
  92     void run(const Window &window, const ThreadInfo &info) override;
  93
  94 private:
  95     /** Template function to run the NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel
  96      *
  97      * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()).
  98      */
  99     template <bool is_bounded_relu>
 100     void run(const Window &window);
 101
 102     /** Common signature for all the specialised NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel functions
 103      *
 104      * @param[in] window Region on which to execute the kernel.
 105      */
 106     using QuantizeDownFunctionPtr = void (NEGEMMLowpQuantizeDownInt32ToUint8ScaleKernel::*)(const Window &window);
 107
 108     QuantizeDownFunctionPtr _func;
 109     const ITensor          *_input;
 110     const ITensor          *_bias;
 111     ITensor                *_output;
 112     int                     _result_offset;
 113     int                     _result_mult_int;
 114     int                     _result_shift;
 115     int                     _min;
 116     int                     _max;
 117 };
 118 } // namespace arm_compute
 119
 120 #endif /* __ARM_COMPUTE_NEGEMMLOWPQUANTIZEDOWNINT32TOUINT8SCALEKERNEL_H__ */