1 /* 2 * Copyright (c) 2018-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_CLUNSTACK_H 25 #define ARM_COMPUTE_CLUNSTACK_H 26 27 #include "arm_compute/core/CL/OpenCL.h" 28 #include "arm_compute/core/Types.h" 29 #include "arm_compute/runtime/IFunction.h" 30 31 #include "arm_compute/runtime/CL/functions/CLStridedSlice.h" 32 33 #include <memory> 34 35 namespace arm_compute 36 { 37 class ICLTensor; 38 39 /** Basic function to unpack a rank-R tensor into rank-(R-1) tensors. This function calls the following functions: 40 * 41 * -# @ref CLStridedSlice 42 * 43 */ 44 class CLUnstack : public IFunction 45 { 46 public: 47 /** Default constructor */ 48 CLUnstack(); 49 /** Set the input, output and unstacking axis. 50 * 51 * Valid data layouts: 52 * - All 53 * 54 * Valid data type configurations: 55 * |src |dst | 56 * |:--------------|:--------------| 57 * |All |All | 58 * 59 * @param[in] input A tensor to be unstacked. Data type supported: All. 60 * @param[in,out] output_vector A vector of tensors. Data types supported: same as @p input. 61 * Note: The number of elements of the vector will be used as the number of slices to be taken from the axis. 62 * @param[in] axis The axis to unstack along. Valid values are [-R,R) where R is the input's rank. Negative values wrap around. 63 * 64 */ 65 void configure(const ICLTensor *input, const std::vector<ICLTensor *> &output_vector, int axis); 66 /** Set the input, output and unstacking axis. 67 * 68 * @param[in] compile_context The compile context to be used. 69 * @param[in] input A tensor to be unstacked. Data type supported: All. 70 * @param[in,out] output_vector A vector of tensors. Data types supported: same as @p input. 71 * Note: The number of elements of the vector will be used as the number of slices to be taken from the axis. 72 * @param[in] axis The axis to unstack along. Valid values are [-R,R) where R is the input's rank. Negative values wrap around. 73 * 74 */ 75 void configure(const CLCompileContext &compile_context, const ICLTensor *input, const std::vector<ICLTensor *> &output_vector, int axis); 76 /** Static function to check if given info will lead to a valid configuration of @ref CLUnstack 77 * 78 * @param[in] input Input tensor info. Data type supported: All. 79 * @param[in] output_vector Vector of output tensors' info. Data types supported: same as @p input. 80 * @param[in] axis The axis to unstack along. Valid values are [-R,R) where R is the input's rank. Negative values wrap around. 81 * 82 * @return a status 83 */ 84 static Status validate(const ITensorInfo *input, const std::vector<ITensorInfo *> &output_vector, int axis); 85 86 // Inherited methods overridden: 87 void run() override; 88 89 private: 90 unsigned int _num_slices; 91 std::vector<CLStridedSlice> _strided_slice_vector; 92 }; 93 } // namespace arm_compute 94 #endif /* ARM_COMPUTE_CLUNSTACK_H */ 95