1 /* 2 * Copyright (c) 2017-2020 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/CL/ICLSimpleFunction.h" 29 30 namespace arm_compute 31 { 32 class CLCompileContext; 33 class ICLTensor; 34 class ITensorInfo; 35 36 /** Basic function to execute flatten. This function calls the following OpenCL kernel: 37 * 38 * -# @ref CLFlattenLayerKernel 39 * 40 */ 41 class CLFlattenLayer : public ICLSimpleFunction 42 { 43 public: 44 /** Initialise the kernel's input and output. 45 * 46 * @param[in] input First input tensor to flatten with at least 3 dimensions. 47 * The dimensions above the third will be interpreted as batches. Data types supported: All. 48 * @param[out] output Output tensor with shape [w*h*d, input_batches] where: 49 * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input 50 */ 51 void configure(const ICLTensor *input, ICLTensor *output); 52 /** Initialise the kernel's input and output. 53 * 54 * @param[in] compile_context The compile context to be used. 55 * @param[in] input First input tensor to flatten with at least 3 dimensions. 56 * The dimensions above the third will be interpreted as batches. Data types supported: All. 57 * @param[out] output Output tensor with shape [w*h*d, input_batches] where: 58 * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input 59 */ 60 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output); 61 /** Static function to check if given info will lead to a valid configuration of @ref CLFlattenLayer 62 * 63 * @param[in] input First input tensor to flatten with at least 3 dimensions. 64 * The dimensions above the third will be interpreted as batches. Data types supported: All. 65 * @param[out] output Output tensor with shape [w*h*d, input_batches] where: 66 * w = width input tensor, h = height input tensor and d = depth input tensor. Data type supported: same as @p input 67 * 68 * @return a status 69 */ 70 static Status validate(const ITensorInfo *input, const ITensorInfo *output); 71 }; 72 } // namespace arm_compute 73 74 #endif /* ARM_COMPUTE_CLFLATTENLAYER_H */