summaryrefslogtreecommitdiff
path: root/compute/ARMComputeEx/arm_compute/runtime/NEON/functions/NESpaceToBatchLayerEx.h
blob: 302f9af2e86e22701bebb9ef7f8cbc5552b65f55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 * Copyright (c) 2019 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef __ARM_COMPUTE_NESPACETOBATCHLAYEREX_H__
#define __ARM_COMPUTE_NESPACETOBATCHLAYEREX_H__

#include "arm_compute/runtime/IFunction.h"

#include "arm_compute/core/NEON/kernels/NEMemsetKernel.h"
#include "arm_compute/core/NEON/kernels/NESpaceToBatchLayerKernel.h"
#include "arm_compute/core/Types.h"

namespace arm_compute
{
class ITensor;

/** Basic function to spatial divide a tensor. This function calls the following NEON
 * kernels/functions:
 *
 *  -# @ref NEMemsetKernel
 *  -# @ref NESpaceToBatchLayerKernel
 */
class NESpaceToBatchLayerEx : public IFunction
{
public:
  /** Default constructor */
  NESpaceToBatchLayerEx();
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  NESpaceToBatchLayerEx(const NESpaceToBatchLayerEx &) = delete;
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  NESpaceToBatchLayerEx &operator=(const NESpaceToBatchLayerEx &) = delete;
  /** Allow instances of this class to be moved */
  NESpaceToBatchLayerEx(NESpaceToBatchLayerEx &&) = default;
  /** Allow instances of this class to be moved */
  NESpaceToBatchLayerEx &operator=(NESpaceToBatchLayerEx &&) = default;
  /** Default destructor */
  virtual ~NESpaceToBatchLayerEx() = default;
  /** Set the input and output tensors.
   *
   * @param[in]  input       Tensor input. Supported tensor rank: 4. Data types supported:
   * U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32.
   * @param[in]  block_shape 1-D tensor with shape [M]. Data types supported: S32
   * @param[in]  paddings    2-D tensor with shape [2, M]. Data types supported: S32
   * @param[out] output      Tensor output. Data types supported: same as @p input
   */
  void configure(const ITensor *input, const ITensor *block_shape, const ITensor *paddings,
                 ITensor *output);
  /** Set the input and output tensors. (Static block shape and paddings)
   *
   * @param[in]  input         Tensor input. Supported tensor rank: 4. Data types supported:
   * U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32.
   * @param[in]  block_shape_x Block shape x value.
   * @param[in]  block_shape_y Block shape y value.
   * @param[in]  padding_left  The left padding of the output tensor.
   * @param[in]  padding_right The right padding of the output tensor.
   * @param[out] output        Tensor output. Data types supported: same as @p input
   */
  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);
  /** Static function to check if given info will lead to a valid configuration of @ref
   * NESpaceToBatchLayerEx
   *
   * @param[in] input       Tensor input info. Supported tensor rank: 4. Data types supported:
   * U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32.
   * @param[in] block_shape block shape tensor info with shape [M]. Data types supported: S32
   * @param[in] paddings    paddings tensor info with shape [2, M]. Data types supported: S32
   * @param[in] output      Tensor output info. Data types supported: same as @p input
   *
   * @return a status
   */
  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 @ref
   * NESpaceToBatchLayerEx (Static block shape and paddings)
   *
   * @param[in] input         Tensor input info. Supported tensor rank: 4. Data types supported:
   * U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32.
   * @param[in] block_shape_x Block shape x value.
   * @param[in] block_shape_y Block shape y value.
   * @param[in] padding_left  The left padding of the output tensor.
   * @param[in] padding_right The right padding of the output tensor.
   * @param[in] output        Tensor output info. Data types supported: same as @p input
   *
   * @return a status
   */
  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);

  // Inherited methods overridden:
  void run() override;

private:
  NESpaceToBatchLayerKernel _space_to_batch_kernel; /**< SpaceToBatch kernel to run */
  NEMemsetKernel _memset_kernel;                    /**< Memset kernel to run */
  bool _has_padding;                                /**< Flag to check if the output has padding */
};
} // namespace arm_compute
#endif /* __ARM_COMPUTE_NESPACETOBATCHLAYEREX_H__ */