summaryrefslogtreecommitdiff
path: root/compute/ARMComputeEx/arm_compute/core/NEON/kernels/NEOneHotKernel.h
blob: 99bb351bcdbfd915b8631348640fcb1bb19a1bd7 (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
136
137
/*
 * 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) 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_NEONEHOTKERNEL_H__
#define __ARM_COMPUTE_NEONEHOTKERNEL_H__
#include "arm_compute/core/NEON/INEKernel.h"
#include "arm_compute/core/Types.h"
namespace arm_compute
{
// Forward declarations
class ITensor;
/** Kernel to perform other operation on NEON */
class NEOneHotKernel : public INEKernel
{
public:
  /** Default constructor. */
  NEOneHotKernel();
  /** Prevent instances of this class from being copied (As this class contains pointers). */
  NEOneHotKernel(const NEOneHotKernel &) = delete;
  /** Prevent instances of this class from being copied (As this class contains pointers). */
  NEOneHotKernel &operator=(const NEOneHotKernel &) = delete;
  /** Allow instances of this class to be moved. */
  NEOneHotKernel(NEOneHotKernel &&) = default;
  /** Allow instances of this class to be moved. */
  NEOneHotKernel &operator=(NEOneHotKernel &&) = default;
  /** Default detructor */
  ~NEOneHotKernel() = default;
  /** Name of the kernel
   *
   * @return Kernel name
   */
  const char *name() const override { return "NEOneHotKernel"; }
  /** Initialise the kernel's inputs and outputs
   *
 * @param[in]  indices   Indices tensor. Supported tensor rank: up to 3. Must be one of the
 * following types: U32/S32
 * @param[in]  depth     The tensor for depth of the one hot dimension. Supported tensor rank: up to
 * 3. Must be one of the following types: U32/S32
 * @param[in]  on_value  On value tensor. Supported tensor rank: only 1. Data type supported:
 * U8/S8/U16/S16/F16/U32/S32/F32
 * @param[in]  off_value Off value tensor. Supported tensor rank: only 1. Data type supported: Same
 * as @p on_value
 * @param[out] output    Destination tensor. Data type supported: Same as @p on_value
 * @param[in]  axis      (Optional) The axis to fill. Negative values wrap around. Defaults to -1.
 * The value must be in range [-indices.rank , indices.rank)
   */
  void configure(const ITensor *indices, const ITensor *depth, const ITensor *on_value,
                 const ITensor *off_value, ITensor *output, int axis = -1);
  /** Static function to check if given info will lead to a valid configuration of @ref
 * NEOneHotKernel
   *
 * @param[in]  indices   Indices tensor info. Supported tensor rank: up to 3. Must be one of the
 * following types: U32/S32
 * @param[in]  depth     The tensor info for depth of the one hot dimension. Supported tensor rank:
 * up to 3. Must be one of the following types: U32/S32
 * @param[in]  on_value  On value tensor info. Supported tensor rank: only 1. Data type supported:
 * U8/S8/U16/S16/F16/U32/S32/F32
 * @param[in]  off_value Off value tensor info. Supported tensor rank: only 1. Data type supported:
 * Same as @p on_value
 * @param[out] output    Destination tensor info. Data type supported: Same as @p on_value
 * @param[in]  axis      (Optional) The axis to fill. Negative values wrap around. Defaults to -1.
 * The value must be in range [-indices.rank , indices.rank)
   *
   * @return a status
   */
  static Status validate(const ITensorInfo *indices, const ITensorInfo *depth,
                         const ITensorInfo *on_value, const ITensorInfo *off_value,
                         const ITensorInfo *output, int axis = -1);
  // Inherited methods overridden:
  void run(const Window &window, const ThreadInfo &info) override;

private:
  /** Implementation of the onehot operation for 0 axis.
   *
   * For onehot on the 0 axis an element by element copy is performed.
   *
   * @param[in] window Region on which to execute the kernel. (Must be a region of the window
   * returned by window())
   * @param[in] info   Info about executing thread and CPU.
   */
  template <typename U> void onehot_0_axis(const Window &window, const ThreadInfo &info);
  /** Implementation of the onehot operation.
   *
   * For 1<=axis a row-wise copy is taking place.
   *
   * @param[in] window Region on which to execute the kernel. (Must be a region of the window
   * returned by window())
   * @param[in] info   Info about executing thread and CPU.
   */
  template <typename U> void onehot_n_axis(const Window &window, const ThreadInfo &info);
  using kernel_ptr = void (NEOneHotKernel::*)(const Window &window, const ThreadInfo &info);
  const ITensor *_indices;
  const ITensor *_depth;
  const ITensor *_on_value;
  const ITensor *_off_value;
  int _axis;
  ITensor *_output;
  kernel_ptr _func;
};
} // namespace arm_compute
#endif /* __ARM_COMPUTE_NEONEHOTKERNEL_H__ */