Compute Library
 21.02
NEActivationLayer.h
Go to the documentation of this file.
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_NEACTIVATIONLAYER_H
25 #define ARM_COMPUTE_NEACTIVATIONLAYER_H
26 
28 
29 #include "arm_compute/core/Types.h"
31 
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 // Forward declarations
37 class ITensor;
38 class ITensorInfo;
39 
40 /** Basic function to run @ref cpu::kernels::CpuActivationKernel
41  *
42  * @note The function simulates an activation layer with the specified activation function.
43  */
45 {
46 public:
47  /** Constructor
48  *
49  * @param[in] ctx Runtime context to be used by the function
50  */
51  NEActivationLayer(IRuntimeContext *ctx = nullptr);
52  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  NEActivationLayer(const NEActivationLayer &) = delete;
54  /** Default move constructor */
56  /** Prevent instances of this class from being copied (As this class contains pointers) */
58  /** Default move assignment operator */
60  /** Destructor */
62  /** [NEActivationLayer snippet] **/
63  /** Set the input and output tensor.
64  *
65  * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
66  *
67  * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
68  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
69  * @param[out] output Destination tensor. Data type supported: same as @p input
70  * @param[in] activation_info Activation layer parameters.
71  */
72  void configure(ITensor *input, ITensor *output, ActivationLayerInfo activation_info);
73  /** [NEActivationLayer snippet] **/
74  /** Static function to check if given info will lead to a valid configuration of @ref NEActivationLayer
75  *
76  * @param[in] input Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result
77  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
78  * @param[in] output Destination tensor info. Data type supported: same as @p input
79  * @param[in] act_info Activation layer information.
80  *
81  * @return a status
82  */
83  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info);
84 
85  // Inherited methods overridden
86  void run() override;
87 
88 private:
89  struct Impl;
90  std::unique_ptr<Impl> _impl;
91 };
92 } // namespace arm_computes
93 #endif /* ARM_COMPUTE_NEACTIVATIONLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info)
[NEActivationLayer snippet]
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Activation Layer Information class.
Definition: Types.h:1550
Interface for Neon tensor.
Definition: ITensor.h:36
NEActivationLayer & operator=(const NEActivationLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Copyright (c) 2017-2021 Arm Limited.
void run() override
Run the kernels contained in the function.
Basic function to run cpu::kernels::CpuActivationKernel.
NEActivationLayer(IRuntimeContext *ctx=nullptr)
Constructor.
void configure(ITensor *input, ITensor *output, ActivationLayerInfo activation_info)
[NEActivationLayer snippet]