Compute Library
 21.02
NESpaceToBatchLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2021 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_NESPACETOBATCHLAYER_H
25 #define ARM_COMPUTE_NESPACETOBATCHLAYER_H
26 
28 
29 #include "arm_compute/core/Types.h"
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 class ITensorInfo;
36 class NESpaceToBatchLayerKernel;
37 class NEFill;
38 
39 /** Basic function to spatial divide a tensor. This function calls the following Neon kernels/functions:
40  *
41  * -# @ref NEFill
42  * -# @ref NESpaceToBatchLayerKernel
43  */
45 {
46 public:
47  /** Default constructor */
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  NESpaceToBatchLayer(const NESpaceToBatchLayer &) = delete;
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  /** Allow instances of this class to be moved */
55  /** Allow instances of this class to be moved */
57  /** Default destructor */
59  /** Set the input and output tensors.
60  *
61  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
62  * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
63  * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
64  * @param[out] output Tensor output. Data types supported: same as @p input
65  */
66  void configure(const ITensor *input, const ITensor *block_shape, const ITensor *paddings, ITensor *output);
67  /** Set the input and output tensors. (Static block shape and paddings)
68  *
69  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
70  * @param[in] block_shape_x Block shape x value.
71  * @param[in] block_shape_y Block shape y value.
72  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
73  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
74  * @param[out] output Tensor output. Data types supported: same as @p input
75  */
76  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);
77  /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToBatchLayer
78  *
79  * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All.
80  * @param[in] block_shape 1-D tensor with shape [M]. Supported M: 2. Data types supported: S32
81  * @param[in] paddings 2-D tensor with shape [2, M] (First dimension is the fastest-changing dimension). Supported M: 2. Data types supported: S32
82  * @param[in] output Tensor output info. Data types supported: same as @p input
83  *
84  * @return a status
85  */
86  static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *paddings, const ITensorInfo *output);
87  /** Static function to check if given info will lead to a valid configuration of @ref NESpaceToBatchLayer (Static block shape and paddings)
88  *
89  * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All.
90  * @param[in] block_shape_x Block shape x value.
91  * @param[in] block_shape_y Block shape y value.
92  * @param[in] padding_left The padding at the beginning of every dimension of the output tensor.
93  * @param[in] padding_right The padding at the end of every dimension of the output tensor.
94  * @param[in] output Tensor output info. Data types supported: same as @p input
95  *
96  * @return a status
97  */
98  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);
99 
100  // Inherited methods overridden:
101  void run() override;
102 
103 private:
104  std::unique_ptr<NESpaceToBatchLayerKernel> _space_to_batch_kernel; /**< SpaceToBatch kernel to run */
105  std::unique_ptr<NEFill> _fill_f; /**< Fill function to run */
106  bool _has_padding; /**< Flag to check if the output has padding */
107 };
108 } // namespace arm_compute
109 #endif /* ARM_COMPUTE_NESPACETOBATCHLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
Basic function to spatial divide a tensor.
static Status validate(const ITensorInfo *input, const ITensorInfo *block_shape, const ITensorInfo *paddings, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of NESpaceToBatchLayer.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
NESpaceToBatchLayer()
Default constructor.
void configure(const ITensor *input, const ITensor *block_shape, const ITensor *paddings, ITensor *output)
Set the input and output tensors.
~NESpaceToBatchLayer()
Default destructor.
NESpaceToBatchLayer & operator=(const NESpaceToBatchLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Class for specifying the size of an image or rectangle.
Definition: Size2D.h:34
void run() override
Run the kernels contained in the function.