1 /* 2 * Copyright (c) 2016-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_CLACTIVATIONLAYER_H 25 #define ARM_COMPUTE_CLACTIVATIONLAYER_H 26 27 #include "arm_compute/runtime/CL/ICLOperator.h" 28 #include "arm_compute/runtime/CL/ICLSimpleFunction.h" 29 30 #include "arm_compute/core/Types.h" 31 32 namespace arm_compute 33 { 34 class CLCompileContext; 35 class ICLTensor; 36 class ITensorInfo; 37 38 /** Basic function to run @ref CLActivationLayerKernel 39 * 40 * @note The function simulates an activation layer with the specified activation function. 41 */ 42 class CLActivationLayer : public IFunction 43 { 44 public: 45 /** Constructor 46 * 47 * @param[in] ctx Runtime context to be used by the function 48 */ 49 CLActivationLayer(CLRuntimeContext *ctx = nullptr); 50 /** Destructor */ 51 ~CLActivationLayer(); 52 /** Prevent instances of this class from being copied (As this class contains pointers) */ 53 CLActivationLayer(const CLActivationLayer &) = delete; 54 /** Default move constructor */ 55 CLActivationLayer(CLActivationLayer &&); 56 /** Prevent instances of this class from being copied (As this class contains pointers) */ 57 CLActivationLayer &operator=(const CLActivationLayer &) = delete; 58 /** Default move assignment operator */ 59 CLActivationLayer &operator=(CLActivationLayer &&); 60 /** Set the input and output tensor. 61 * 62 * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place 63 * 64 * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result 65 * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. 66 * @param[out] output Destination tensor. Data type supported: same as @p input 67 * @param[in] act_info Activation layer parameters. 68 */ 69 void configure(ICLTensor *input, ICLTensor *output, ActivationLayerInfo act_info); 70 /** Set the input and output tensor. 71 * 72 * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place 73 * 74 * @param[in] compile_context The compile context to be used. 75 * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result 76 * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. 77 * @param[out] output Destination tensor. Data type supported: same as @p input 78 * @param[in] act_info Activation layer parameters. 79 */ 80 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, ActivationLayerInfo act_info); 81 /** Static function to check if given info will lead to a valid configuration of @ref CLActivationLayer 82 * 83 * @param[in] input Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result 84 * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. 85 * @param[in] output Destination tensor info. Data type supported: same as @p input 86 * @param[in] act_info Activation layer information. 87 * 88 * @return a status 89 */ 90 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info); 91 92 // Inherited methods overridden: 93 void run() override; 94 95 private: 96 struct Impl; 97 std::unique_ptr<Impl> _impl; 98 }; 99 100 namespace experimental 101 { 102 /** Basic function to run @ref CLActivationLayerKernel */ 103 class CLActivation : public ICLOperator 104 { 105 public: 106 /** Set the input and output tensor. 107 * 108 * @param[in] compile_context The compile context to be used. 109 * @param[in, out] input Source tensor info. In case of @p output tensor = nullptr, this tensor will store the result 110 * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. 111 * @param[out] output Destination tensor info. Data type supported: same as @p input 112 * @param[in] act_info Activation layer parameters. 113 */ 114 void configure(const CLCompileContext &compile_context, ITensorInfo *input, ITensorInfo *output, ActivationLayerInfo act_info); 115 /** Static function to check if given info will lead to a valid configuration of @ref CLActivationLayer 116 * 117 * @param[in] input Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result 118 * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. 119 * @param[in] output Destination tensor info. Data type supported: same as @p input 120 * @param[in] act_info Activation layer information. 121 * 122 * @return a status 123 */ 124 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info); 125 }; 126 } // namespace experimental 127 } // namespace arm_compute 128 #endif /* ARM_COMPUTE_CLACTIVATIONLAYER_H */ 129