• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2019-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_NESPACETOBATCHLAYERKERNEL_H
25 #define ARM_COMPUTE_NESPACETOBATCHLAYERKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/NEON/INEKernel.h"
29 
30 namespace arm_compute
31 {
32 // Forward declaration
33 class ITensor;
34 
35 /** Interface for the space to batch kernel */
36 class NESpaceToBatchLayerKernel : public INEKernel
37 {
38 public:
name()39     const char *name() const override
40     {
41         return "NESpaceToBatchLayerKernel";
42     }
43     /** Default constructor */
44     NESpaceToBatchLayerKernel();
45     /** Prevent instances of this class from being copied (As this class contains pointers) */
46     NESpaceToBatchLayerKernel(const NESpaceToBatchLayerKernel &) = delete;
47     /** Prevent instances of this class from being copied (As this class contains pointers) */
48     NESpaceToBatchLayerKernel &operator=(const NESpaceToBatchLayerKernel &) = delete;
49     /** Allow instances of this class to be moved */
50     NESpaceToBatchLayerKernel(NESpaceToBatchLayerKernel &&) = default;
51     /** Allow instances of this class to be moved */
52     NESpaceToBatchLayerKernel &operator=(NESpaceToBatchLayerKernel &&) = default;
53     /** Default destructor */
54     ~NESpaceToBatchLayerKernel() = default;
55     /** Initialise the kernel's inputs and output.
56      *
57      * @param[in]  input       Tensor input. Supported tensor rank: 4. Data types supported: All.
58      * @param[in]  block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
59      * @param[in]  paddings    2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
60      * @param[out] output      Tensor output. Data types supported: same as @p input
61      */
62     void configure(const ITensor *input, const ITensor *block_shape, const ITensor *paddings, ITensor *output);
63     /** Initialise the kernel's input and output. (Static block shape and paddings)
64      *
65      * @param[in]  input         Tensor input. Supported tensor rank: 4. Data types supported: All.
66      * @param[in]  block_shape_x Block shape x value.
67      * @param[in]  block_shape_y Block shape y value.
68      * @param[in]  padding_left  The padding at the beginning of every dimension of the output tensor.
69      * @param[in]  padding_right The padding at the end of every dimension of the output tensor.
70      * @param[out] output        Tensor output. Data types supported: same as @p input
71      */
72     void configure(const ITensor *input, const int block_shape_x, const int block_shape_y, const Size2D &padding_left, const Size2D &padding_right, ITensor *output);
73     /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToBatchLayerKernel
74      *
75      * @param[in] input       Tensor input. Supported tensor rank: 4. Data types supported: All.
76      * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
77      * @param[in] paddings    2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
78      * @param[in] output      Tensor output. Data types supported: same as @p input
79      *
80      * @return a status
81      */
82     static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *paddings, const ITensorInfo *output);
83     /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToBatchLayerKernel (Static block shape and paddings)
84      *
85      * @param[in] input         Tensor input. Supported tensor rank: 4. Data types supported: All.
86      * @param[in] block_shape_x Block shape x value.
87      * @param[in] block_shape_y Block shape y value.
88      * @param[in] padding_left  The padding at the beginning of every dimension of the output tensor.
89      * @param[in] padding_right The padding at the end of every dimension of the output tensor.
90      * @param[in] output        Tensor output. Data types supported: same as @p input
91      *
92      * @return a status
93      */
94     static Status validate(const ITensorInfo *input, const int block_shape_x, const int block_shape_y, const Size2D &padding_left, const Size2D &padding_right, const ITensorInfo *output);
95 
96     // Inherited methods overridden:
97     void run(const Window &window, const ThreadInfo &info) override;
98 
99 private:
100     const ITensor *_input;       /**< Source tensor */
101     const ITensor *_block_shape; /**< Block shape tensor for dynamic evaluation */
102     const ITensor *_paddings;    /**< Paddings tensor for dynamic evaluation */
103     ITensor       *_output;      /**< Destination tensor */
104     DataLayout     _data_layout; /**< Data layout to be used at run-time */
105 
106     Size2D _padding_left;
107     int    _block_shape_x;
108     int    _block_shape_y;
109 };
110 } // namespace arm_compute
111 #endif /* ARM_COMPUTE_NESPACETOBATCHLAYERKERNEL_H */
112