compute/ARMComputeEx/arm_compute/core/CPP/kernels/CPPOneHotKernelEx.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * Copyright (c) 2019 ARM Limited.
  19  *
  20  * SPDX-License-Identifier: MIT
  21  *
  22  * Permission is hereby granted, free of charge, to any person obtaining a copy
  23  * of this software and associated documentation files (the "Software"), to
  24  * deal in the Software without restriction, including without limitation the
  25  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  26  * sell copies of the Software, and to permit persons to whom the Software is
  27  * furnished to do so, subject to the following conditions:
  28  *
  29  * The above copyright notice and this permission notice shall be included in all
  30  * copies or substantial portions of the Software.
  31  *
  32  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  33  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  34  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  35  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  36  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  37  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  38  * SOFTWARE.
  39  */
  40
  41 #ifndef __ARM_COMPUTE_CPPONEHOTERNEL_H__
  42 #define __ARM_COMPUTE_CPPONEHOTERNEL_H__
  43
  44 #include "arm_compute/core/CPP/ICPPKernel.h"
  45
  46 namespace arm_compute
  47 {
  48 class ITensor;
  49
  50 /** CPP kernel to perform tensor OneHot operation. */
  51 class CPPOneHotKernelEx : public ICPPKernel
  52 {
  53 public:
  54   const char *name() const override { return "CPPOneHotKernelEx"; }
  55   /** Default constructor */
  56   CPPOneHotKernelEx();
  57   /** Prevent instances of this class from being copied (As this class contains pointers) */
  58   CPPOneHotKernelEx(const CPPOneHotKernelEx &) = delete;
  59   /** Prevent instances of this class from being copied (As this class contains pointers) */
  60   CPPOneHotKernelEx &operator=(const CPPOneHotKernelEx &) = delete;
  61   /** Allow instances of this class to be moved */
  62   CPPOneHotKernelEx(CPPOneHotKernelEx &&) = default;
  63   /** Allow instances of this class to be moved */
  64   CPPOneHotKernelEx &operator=(CPPOneHotKernelEx &&) = default;
  65   /** Default destructor */
  66   ~CPPOneHotKernelEx() = default;
  67
  68   /** Set the input and output of the kernel.
  69    *
  70    * @param[in]  indices     A tensor for indices. Data types supported: S32
  71    * @param[in]  depth       A tensor for depth. Data types supported: S32
  72    * @param[in]  on_value    A tensor for on_value. Data types supported: F32
  73    * @param[in]  off_value   A tensor for off_value. Data types supported: F32*
  74    * @param[out] output      A tensor for computed value of one hot operator
  75    * @param[in]  axis        An int value for axis
  76    */
  77   void configure(const ITensor *indices, const ITensor *depth, const ITensor *on_value,
  78                  const ITensor *off_value, ITensor *output, const int axis);
  79
  80   /** Static function to check if given info will lead to a valid configuration of @ref
  81    * CPPOneHotKernelEx
  82    *
  83    * @param[in]  indices     A tensor for indices. Data types supported: S32
  84    * @param[in]  depth       A tensor for depth. Data types supported: S32
  85    * @param[in]  on_value    A tensor for on_value. Data types supported: F32
  86    * @param[in]  off_value   A tensor for off_value. Data types supported: F32*
  87    * @param[in]  axis        An int value for axis
  88    *
  89    * @return a status
  90    */
  91   static Status validate(const ITensor *indices, const ITensor *depth, const ITensor *on_value,
  92                          const ITensor *off_value, const int axis);
  93
  94   // Inherited methods overridden:
  95   void run(const Window &window, const ThreadInfo &info) override;
  96   bool is_parallelisable() const override;
  97
  98 private:
  99   /** Template function to run the topKV operation. */
 100   template <typename T> void run_one_hot();
 101
 102   const ITensor *_indices;
 103   const ITensor *_depth;
 104   const ITensor *_on_value;
 105   const ITensor *_off_value;
 106   ITensor *_output;
 107   int _axis;
 108 };
 109 } // namespace arm_compute
 110 #endif /*__ARM_COMPUTE_CPPONEHOTKERNEL_H__ */