compute/ARMComputeEx/arm_compute/runtime/NEON/functions/NEOneHot.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 #ifndef __ARM_COMPUTE_NEONEHOT_H__
  41 #define __ARM_COMPUTE_NEONEHOT_H__
  42 #include "arm_compute/core/Types.h"
  43 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h"
  44 namespace arm_compute
  45 {
  46 // Forward declarations
  47 class ITensor;
  48 /** Basic function to run @ref NEOneHotKernel */
  49 class NEOneHot : public INESimpleFunctionNoBorder
  50 {
  51 public:
  52   /** Initialise the kernel's inputs and outputs
  53    *
  54    * @param[in]  indices   Indices tensor. Supported tensor rank: up to 3. Must be one of the
  55    * following types: U32/S32
  56    * @param[in]  depth     The tensor for depth of the one hot dimension. Supported tensor rank: up
  57    * to 3. Must be one of the following types: U32/S32
  58    * @param[in]  on_value  On value tensor. Supported tensor rank: only 1. Data type supported:
  59    * U8/S8/U16/S16/F16/U32/S32/F32
  60    * @param[in]  off_value Off value tensor. Supported tensor rank: only 1. Data type supported:
  61    * Same as @p on_value
  62    * @param[out] output    Destination tensor. Data type supported: Same as @p on_value
  63    * @param[in]  axis      (Optional) The axis to fill. Negative values wrap around. Defaults to -1.
  64    * The value must be in range [-indices.rank , indices.rank)
  65    */
  66   void configure(const ITensor *indices, const ITensor *depth, const ITensor *on_value,
  67                  const ITensor *off_value, ITensor *output, int axis = -1);
  68   /** Static function to check if given info will lead to a valid configuration of @ref
  69    * NEOneHotKernel
  70    *
  71    * @param[in]  indices   Indices tensor info. Supported tensor rank: up to 3.
  72    *                       Must be one of the following types: U32/S32
  73    * @param[in]  depth     The tensor info for depth of the one hot dimension.
  74    *                       Supported tensor rank: up to 3.
  75    *                       Must be one of the following types: U32/S32
  76    * @param[in]  on_value  On value tensor info. Supported tensor rank: only 1.
  77    *                       Data type supported: U8/S8/U16/S16/F16/U32/S32/F32
  78    * @param[in]  off_value Off value tensor info. Supported tensor rank: only 1.
  79    *                       Data type supported: Same as @p on_value
  80    * @param[out] output    Destination tensor info. Data type supported: Same as @p on_value
  81    * @param[in]  axis      (Optional) The axis to fill. Negative values wrap around. Defaults to -1.
  82    *                       The value must be in range [-indices.rank , indices.rank)
  83    *
  84    * @return a status
  85    */
  86   static Status validate(const ITensorInfo *indices, const ITensorInfo *depth,
  87                          const ITensorInfo *on_value, const ITensorInfo *off_value,
  88                          const ITensorInfo *output, int axis = -1);
  89 };
  90 } // namespace arm_compute
  91 #endif /* __ARM_COMPUTE_NEONEHOT_H__ */