summaryrefslogtreecommitdiff
path: root/compute/ARMComputeEx/arm_compute/core/NEON/kernels/NEActivationLayerKernelEx.h
blob: a827f48f840f36bf2c32fd19e5203877826c575e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * Copyright (c) 2017-2019 ARM Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __ARM_COMPUTE_NEACTIVATIONLAYERKERNELEX_H__
#define __ARM_COMPUTE_NEACTIVATIONLAYERKERNELEX_H__

#include "arm_compute/core/NEON/INEKernel.h"
#include "arm_compute/core/utils/misc/Traits.h"

#ifdef __ARM_FEATURE_FP16_VECTOR_ARITHMETIC
#include <arm_fp16.h>
#endif /* __ARM_FEATURE_FP16_VECTOR_ARITHMETIC */

namespace arm_compute
{
class ITensor;

/** Interface for the activation layer kernel. */
class NEActivationLayerKernelEx : public INEKernel
{
public:
  const char *name() const override { return "NEActivationLayerKernelEx"; }
  /** Constructor */
  NEActivationLayerKernelEx();
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  NEActivationLayerKernelEx(const NEActivationLayerKernelEx &) = delete;
  /** Default move constructor */
  NEActivationLayerKernelEx(NEActivationLayerKernelEx &&) = default;
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  NEActivationLayerKernelEx &operator=(const NEActivationLayerKernelEx &) = delete;
  /** Default move assignment operator */
  NEActivationLayerKernelEx &operator=(NEActivationLayerKernelEx &&) = default;
  /** Set the input and output tensor.
   *
   * @note If the output tensor is a nullptr, the activation function will be performed in-place
   *
   * @param[in, out] input           Source tensor. In case of @p output tensor = nullptr, this
   * tensor will store the result
   *                                 of the activation function. Data types supported:
   * QASYMM8/QSYMM16/F16/F32.
   * @param[out]     output          Destination tensor. Data type supported: same as @p input
   * @param[in]      activation_info Activation layer information.
   */
  void configure(ITensor *input, ITensor *output, ActivationLayerInfo activation_info);
  /** Static function to check if given info will lead to a valid configuration of @ref
   * NEActivationLayerKernelEx
   *
   * @param[in] input    Source tensor info. In case of @p output tensor info = nullptr, this tensor
   * will store the result
   *                     of the activation function. Data types supported: QASYMM8/QSYMM16/F16/F32.
   * @param[in] output   Destination tensor info. Data type supported: same as @p input
   * @param[in] act_info Activation layer information.
   *
   * @return a status
   */
  static Status validate(const ITensorInfo *input, const ITensorInfo *output,
                         const ActivationLayerInfo &act_info);

  // Inherited methods overridden:
  void run(const Window &window, const ThreadInfo &info) override;

private:
  using ActivationFunction = ActivationLayerInfo::ActivationFunction;
  /** Common signature for all the specialised @ref NEActivationLayerKernelEx functions
   *
   * @param[in] window Region on which to execute the kernel.
   */
  using ActivationFunctionExecutorPtr = void (NEActivationLayerKernelEx::*)(const Window &window);
  /** Function to apply an activation function on a tensor.
   *
   * @param[in] window Region on which to execute the kernel
   */
  template <ActivationLayerInfo::ActivationFunction F, typename T>
  typename std::enable_if<arm_compute::utils::traits::is_floating_point<T>::value, void>::type
  activation(const Window &window);
  /** Function to apply an activation function on a tensor.
   *
   * @param[in] window Region on which to execute the kernel
   */
  template <ActivationLayerInfo::ActivationFunction F, typename T>
  typename std::enable_if<std::is_same<T, qasymm8_t>::value, void>::type
  activation(const Window &window);
  /** Function to apply an activation function on a tensor.
   *
   * @param[in] window Region on which to execute the kernel
   */
  template <ActivationLayerInfo::ActivationFunction F, typename T>
  typename std::enable_if<std::is_same<T, qsymm16_t>::value, void>::type
  activation(const Window &window);

private:
  ITensor *_input;
  ITensor *_output;
  ActivationFunctionExecutorPtr _func;
  ActivationLayerInfo _act_info;
};
} // namespace arm_compute
#endif /*__ARM_COMPUTE_NEACTIVATIONLAYERKERNELEX_H__ */