1 /* 2 * Copyright (c) 2017-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_CLFLATTENLAYER_H 25 #define ARM_COMPUTE_CLFLATTENLAYER_H 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/runtime/IFunction.h" 29 30 #include <memory> 31 namespace arm_compute 32 { 33 class CLCompileContext; 34 class ICLTensor; 35 class ITensorInfo; 36 37 /** Basic function to execute flatten */ 38 class CLFlattenLayer : public IFunction 39 { 40 public: 41 CLFlattenLayer(); 42 /** Destructor */ 43 ~CLFlattenLayer(); 44 /** Prevent instances of this class from being copied (As this class contains pointers) */ 45 CLFlattenLayer(const CLFlattenLayer &) = delete; 46 /** Default move constructor */ 47 CLFlattenLayer(CLFlattenLayer &&); 48 /** Prevent instances of this class from being copied (As this class contains pointers) */ 49 CLFlattenLayer &operator=(const CLFlattenLayer &) = delete; 50 /** Default move assignment operator */ 51 CLFlattenLayer &operator=(CLFlattenLayer &&); 52 /** Initialise the kernel's input and output. 53 * 54 * Valid data layouts: 55 * - All 56 * 57 * Valid data type configurations: 58 * |src |dst | 59 * |:--------------|:--------------| 60 * |All |All | 61 * 62 * @param[in] input First input tensor to flatten with at least 3 dimensions. 63 * The dimensions above the third will be interpreted as batches. Data types supported: All. 64 * @param[out] output Output tensor with shape [w*h*d, input_batches] where: 65 * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input 66 */ 67 void configure(const ICLTensor *input, ICLTensor *output); 68 /** Initialise the kernel's input and output. 69 * 70 * @param[in] compile_context The compile context to be used. 71 * @param[in] input First input tensor to flatten with at least 3 dimensions. 72 * The dimensions above the third will be interpreted as batches. Data types supported: All. 73 * @param[out] output Output tensor with shape [w*h*d, input_batches] where: 74 * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input 75 */ 76 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output); 77 /** Static function to check if given info will lead to a valid configuration of @ref CLFlattenLayer 78 * 79 * @param[in] input First input tensor to flatten with at least 3 dimensions. 80 * The dimensions above the third will be interpreted as batches. Data types supported: All. 81 * @param[out] output Output tensor with shape [w*h*d, input_batches] where: 82 * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input 83 * 84 * @return a status 85 */ 86 static Status validate(const ITensorInfo *input, const ITensorInfo *output); 87 88 // Inherited methods overridden: 89 void run() override; 90 91 private: 92 struct Impl; 93 std::unique_ptr<Impl> _impl; 94 }; 95 } // namespace arm_compute 96 97 #endif /* ARM_COMPUTE_CLFLATTENLAYER_H */