| /* |
| * Copyright (c) 2018-2020 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_CLCONCATENATELAYER_H |
| #define ARM_COMPUTE_CLCONCATENATELAYER_H |
| |
| #include "arm_compute/runtime/IFunction.h" |
| |
| #include "arm_compute/core/CL/ICLKernel.h" |
| #include "arm_compute/core/Types.h" |
| |
| #include <memory> |
| #include <vector> |
| |
| namespace arm_compute |
| { |
| // Forward declarations |
| class ICLTensor; |
| class ITensorInfo; |
| class Status; |
| |
| /** Basic function to execute concatenate tensors along a given axis. This function calls the following kernels: |
| * |
| * -# @ref CLWidthConcatenateLayerKernel (if underlying concatenation axis is 0). |
| * -# @ref CLHeightConcatenateLayerKernel (if underlying concatenation axis is 1). |
| * -# @ref CLDepthConcatenateLayerKernel (if underlying concatenation axis is 2). |
| * -# @ref CLBatchConcatenateLayerKernel (if underlying concatenation axis is 3). |
| */ |
| class CLConcatenateLayer : public IFunction |
| { |
| public: |
| /** Default constructor */ |
| CLConcatenateLayer(); |
| /** Initialise the kernel's inputs vector and output. |
| * |
| * @note Input and output tensor dimensions preconditions defer depending on the concatenation axis. |
| * @note Preconditions can be found respectively at @ref CLWidthConcatenateLayerKernel, @ref CLHeightConcatenateLayerKernel and @ref CLDepthConcatenateLayerKernel. |
| * |
| * @param[in,out] inputs_vector The vectors containing all the tensors to concatenate. Data types supported: All. |
| * @param[out] output Output tensor. Data types supported: Same as @p input. |
| * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3. |
| */ |
| void configure(std::vector<ICLTensor *> &inputs_vector, ICLTensor *output, size_t axis); |
| void configure(std::vector<const ICLTensor *> &inputs_vector, ICLTensor *output, size_t axis); |
| /** Initialise the kernel's inputs vector and output. |
| * |
| * @note Input and output tensor dimensions preconditions defer depending on the concatenation axis. |
| * @note Preconditions can be found respectively at @ref CLWidthConcatenateLayerKernel, @ref CLHeightConcatenateLayerKernel and @ref CLDepthConcatenateLayerKernel. |
| * |
| * @param[in] compile_context The compile context to be used. |
| * @param[in,out] inputs_vector The vectors containing all the tensors to concatenate. Data types supported: All. |
| * @param[out] output Output tensor. Data types supported: Same as @p input. |
| * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3. |
| */ |
| void configure(const CLCompileContext &compile_context, std::vector<ICLTensor *> &inputs_vector, ICLTensor *output, size_t axis); |
| void configure(const CLCompileContext &compile_context, std::vector<const ICLTensor *> &inputs_vector, ICLTensor *output, size_t axis); |
| /** Static function to check if given info will lead to a valid configuration of @ref CLConcatenateLayer |
| * |
| * @note Input and output tensor dimensions preconditions defer depending on the concatenation axis. |
| * @note Preconditions can be found respectively at @ref CLWidthConcatenateLayerKernel, @ref CLHeightConcatenateLayerKernel and @ref CLDepthConcatenateLayerKernel. |
| * |
| * @param[in] inputs_vector The vectors containing all the tensors info to concatenate. Data types supported: All. |
| * @param[in] output Output tensor info. Data types supported: Same as @p input. |
| * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3. |
| * |
| * @return a status |
| */ |
| static Status validate(const std::vector<ITensorInfo *> &inputs_vector, const ITensorInfo *output, size_t axis); |
| static Status validate(const std::vector<const ITensorInfo *> &inputs_vector, const ITensorInfo *output, size_t axis); |
| |
| // Inherited methods overridden: |
| void run() override; |
| |
| private: |
| template <typename TensorType> |
| void configure_internal(const CLCompileContext &compile_context, std::vector<TensorType *> &&inputs_vector, ICLTensor *output, size_t axis); |
| |
| template <typename TensorInfoType> |
| static Status validate_internal(const std::vector<TensorInfoType *> &inputs_vector, const ITensorInfo *output, size_t axis); |
| |
| std::vector<std::unique_ptr<ICLKernel>> _concat_kernels; |
| unsigned int _num_inputs; |
| unsigned int _axis; |
| }; |
| } // namespace arm_compute |
| #endif /* ARM_COMPUTE_CLCONCATENATELAYER_H */ |