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_NEACTIVATIONLAYER_H 25 #define ARM_COMPUTE_NEACTIVATIONLAYER_H 26 27 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h" 28 29 #include "arm_compute/core/Types.h" 30 #include "arm_compute/runtime/NEON/INEOperator.h" 31 32 namespace arm_compute 33 { 34 // Forward declarations 35 class ITensor; 36 37 /** Basic function to run @ref NEActivationLayerKernel 38 * 39 * @note The function simulates an activation layer with the specified activation function. 40 */ 41 class NEActivationLayer : public IFunction 42 { 43 public: 44 /** Constructor 45 * 46 * @param[in] ctx Runtime context to be used by the function 47 */ 48 NEActivationLayer(IRuntimeContext *ctx = nullptr); 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NEActivationLayer(const NEActivationLayer &) = delete; 51 /** Default move constructor */ 52 NEActivationLayer(NEActivationLayer &&); 53 /** Prevent instances of this class from being copied (As this class contains pointers) */ 54 NEActivationLayer &operator=(const NEActivationLayer &) = delete; 55 /** Default move assignment operator */ 56 NEActivationLayer &operator=(NEActivationLayer &&); 57 /** Destructor */ 58 ~NEActivationLayer(); 59 /** [NEActivationLayer snippet] **/ 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] activation_info Activation layer parameters. 68 */ 69 void configure(ITensor *input, ITensor *output, ActivationLayerInfo activation_info); 70 /** [NEActivationLayer snippet] **/ 71 /** Static function to check if given info will lead to a valid configuration of @ref NEActivationLayer 72 * 73 * @param[in] input Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result 74 * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. 75 * @param[in] output Destination tensor info. Data type supported: same as @p input 76 * @param[in] act_info Activation layer information. 77 * 78 * @return a status 79 */ 80 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info); 81 82 // Inherited methods overridden 83 void run() override; 84 85 private: 86 struct Impl; 87 std::unique_ptr<Impl> _impl; 88 }; 89 90 namespace experimental 91 { 92 /** Basic function to run @ref NEActivationLayerKernel */ 93 class NEActivationLayer : public INEOperator 94 { 95 public: 96 /** Constructor */ 97 NEActivationLayer() = default; 98 /** Prevent instances of this class from being copied */ 99 NEActivationLayer(const NEActivationLayer &) = delete; 100 /** Default move constructor */ 101 NEActivationLayer(NEActivationLayer &&) = default; 102 /** Prevent instances of this class from being copied */ 103 NEActivationLayer &operator=(const NEActivationLayer &) = delete; 104 /** Default move assignment operator */ 105 NEActivationLayer &operator=(NEActivationLayer &&) = default; 106 /** Destructor */ 107 ~NEActivationLayer(); 108 109 /** Set the input and output tensor. 110 * 111 * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. 112 * @param[out] output Destination tensor info. Data type supported: same as @p input 113 * @param[in] activation_info Activation layer parameters. 114 */ 115 void configure(const ITensorInfo *input, ITensorInfo *output, const ActivationLayerInfo &activation_info); 116 /** Static function to check if given info will lead to a valid configuration of @ref NEActivationLayer 117 * 118 * @param[in] input Source tensor info. 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_NEACTIVATIONLAYER_H */ 129