compute/ARMComputeEx/arm_compute/runtime/CL/functions/CLSpaceToBatchND.h

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * Copyright (c) 2016-2018 ARM Limited.
  19  *
  20  * SPDX-License-Identifier: MIT
  21  *
  22  * Permission is hereby granted, free of charge, to any person obtaining a copy
  23  * of this software and associated documentation files (the "Software"), to
  24  * deal in the Software without restriction, including without limitation the
  25  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  26  * sell copies of the Software, and to permit persons to whom the Software is
  27  * furnished to do so, subject to the following conditions:
  28  *
  29  * The above copyright notice and this permission notice shall be included in all
  30  * copies or substantial portions of the Software.
  31  *
  32  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  33  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  34  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  35  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  36  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  37  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  38  * SOFTWARE.
  39  */
  40
  41 #ifndef __ARM_COMPUTE_CLSPACE_TO_BATCH_ND_H__
  42 #define __ARM_COMPUTE_CLSPACE_TO_BATCH_ND_H__
  43
  44 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
  45
  46 namespace arm_compute
  47 {
  48 class ICLTensor;
  49
  50 /** Basic function to run @ref CLSpaceToBatchNDKernel
  51  *
  52  * @note The tensor data type for the inputs must be U8/QASYMM8/S16/F16/S32/F32.
  53  * @note The function divides "spatial" dimensions of the input into a grid of blocks of shape
  54  * block_shape, and interleaves these blocks with the "batch" dimension such that in the output.
  55  */
  56 class CLSpaceToBatchND : public ICLSimpleFunction
  57 {
  58 public:
  59   /** Initialise the kernel's input and output.
  60    *
  61    * @note       The data layout of input and output must be the same.
  62    * @note       The number of dimensions of input and output must be 4, and `spatial` dimensions
  63    *             are height and width.
  64    * @param[in]  input          Input tensor. Data types supported: U8/QASYMM8/S16/F16/S32/F32.
  65    *                            Data layout supported: NCHW/NHWC
  66    * @param[in]  block_size     Tensor of integer values specifying block sizes for spatial
  67    * dimension.
  68    *                            Data types supported: S32
  69    * @param[in]  padding_size   Tensor of integer values specifying padding sizes for spatial
  70    * dimension.
  71    *                            Data types supported: S32
  72    * @param[out] output         Output tensor. Data types supported: same as @p input.
  73    *                            Data layout supported: NCHW/NHWC
  74    */
  75   void configure(const ICLTensor *input, const ICLTensor *block_size, const ICLTensor *padding_size,
  76                  ICLTensor *output);
  77 };
  78
  79 } // namespace arm_compute
  80 #endif /* __ARM_COMPUTE_CLSPACE_TO_BATCH_ND_H__ */