summaryrefslogtreecommitdiff
path: root/compute/ARMComputeEx/arm_compute/core/CPP/kernels/CPPOneHotKernelEx.h
blob: 59c337a12f732b594571361183d499644682534a (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
/*
 * 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_CPPONEHOTERNEL_H__
#define __ARM_COMPUTE_CPPONEHOTERNEL_H__

#include "arm_compute/core/CPP/ICPPKernel.h"

namespace arm_compute
{
class ITensor;

/** CPP kernel to perform tensor OneHot operation. */
class CPPOneHotKernelEx : public ICPPKernel
{
public:
  const char *name() const override { return "CPPOneHotKernelEx"; }
  /** Default constructor */
  CPPOneHotKernelEx();
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CPPOneHotKernelEx(const CPPOneHotKernelEx &) = delete;
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CPPOneHotKernelEx &operator=(const CPPOneHotKernelEx &) = delete;
  /** Allow instances of this class to be moved */
  CPPOneHotKernelEx(CPPOneHotKernelEx &&) = default;
  /** Allow instances of this class to be moved */
  CPPOneHotKernelEx &operator=(CPPOneHotKernelEx &&) = default;
  /** Default destructor */
  ~CPPOneHotKernelEx() = default;

  /** Set the input and output of the kernel.
   *
   * @param[in]  indices     A tensor for indices. Data types supported: S32
   * @param[out] output      A tensor for computed value of one hot operator
   * @param[in]  depth       An int value for depth
   * @param[in]  on_value    A float value for on_value
   * @param[in]  off_value   A float value for off_value
   * @param[in]  axis        An int value for axis
   */
  void configure(const ITensor *indices, ITensor *output, const int depth, const float on_value,
                 const float off_value, const int axis);

  /** Static function to check if given info will lead to a valid configuration of @ref
   * CPPOneHotKernelEx
   *
   * @param[in]  indices     A tensor for indices. Data types supported: S32
   * @param[in]  depth       An int value for depth
   * @param[in]  on_value    A float value for on_value
   * @param[in]  off_value   A float value for off_value
   * @param[in]  axis        An int value for axis
   *
   * @return a status
   */
  static Status validate(const ITensor *indices, const int depth, const float on_value,
                         const float off_value, const int axis);

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

private:
  /** Template function to run the topKV operation. */
  template <typename T> void run_one_hot();

  const ITensor *_indices;
  ITensor *_output;
  int _depth;
  float _on_value;
  float _off_value;
  int _axis;
};
} // namespace arm_compute
#endif /*__ARM_COMPUTE_CPPONEHOTKERNEL_H__ */