arm_compute/runtime/CL/functions/CLWidthConcatenateLayer.h

   1 /*
   2  * Copyright (c) 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_CLWIDTHCONCATENATELAYER_H__
  25 #define __ARM_COMPUTE_CLWIDTHCONCATENATELAYER_H__
  26
  27 #include "arm_compute/core/CL/OpenCL.h"
  28 #include "arm_compute/core/Types.h"
  29 #include "arm_compute/core/Window.h"
  30 #include "arm_compute/runtime/IFunction.h"
  31
  32 #include "arm_compute/core/CL/kernels/CLWidthConcatenateLayerKernel.h"
  33
  34 #include <memory>
  35 #include <vector>
  36
  37 namespace arm_compute
  38 {
  39 class ICLTensor;
  40
  41 /** Basic function to execute concatenate tensors along x axis. This function calls the following kernel:
  42  *
  43  * -# @ref CLDepthConcatenateLayerKernel
  44  *
  45  */
  46 class CLWidthConcatenateLayer : public IFunction
  47 {
  48 public:
  49     /** Default constructor */
  50     CLWidthConcatenateLayer();
  51     /** Initialise the kernel's inputs vector and output.
  52      *
  53      * @param[in,out] inputs_vector The vectors containing all the tensors to concatenate. Data types supported: QS8/QASYMM8/QS16/F16/F32.
  54      * @param[out]    output        Output tensor. Data types supported: Same as @p input.
  55      */
  56     void configure(std::vector<ICLTensor *> inputs_vector, ICLTensor *output);
  57     /** Static function to check if given info will lead to a valid configuration of @ref CLDepthConcatenateLayerKernel
  58      *
  59      * @param[in] inputs_vector The vectors containing all the tensors info to concatenate. Data types supported: QS8/QASYMM8/QS16/F16/F32.
  60      * @param[in] output        Output tensor info. Data types supported: Same as @p input.
  61      *
  62      * @return a status
  63      */
  64     static Status validate(const std::vector<ITensorInfo *> &inputs_vector, const ITensorInfo *output);
  65
  66     // Inherited methods overridden:
  67     void run() override;
  68
  69 private:
  70     std::unique_ptr<CLWidthConcatenateLayerKernel[]> _concat_kernels_vector;
  71     unsigned int                                     _num_inputs;
  72 };
  73 } // namespace arm_compute
  74 #endif /* __ARM_COMPUTE_CLWIDTHCONCATENATELAYER_H__ */