compute/ARMComputeEx/arm_compute/runtime/CL/functions/CLGatherEx.h

   1 /*
   2  * Copyright (c) 2018 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) 2016-2018 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 /**
  42  * @file CLGatherEx.h
  43  * @brief       This file contains CLGatherEx class
  44  * @ingroup     COM_AI_RUNTIME
  45  */
  46
  47 #ifndef __ARM_COMPUTE_CLGATHEREX_H__
  48 #define __ARM_COMPUTE_CLGATHEREX_H__
  49
  50 #include "arm_compute/runtime/CL/ICLSimpleFunction.h"
  51
  52 namespace arm_compute
  53 {
  54 class ICLTensor;
  55
  56 /**
  57  * @brief Class to to run @ref CLGatherKernel.
  58  */
  59 class CLGatherEx : public ICLSimpleFunction
  60 {
  61 public:
  62   /**
  63    * @brief Initialise the kernel's inputs, output and convertion policy.
  64    * @param[in]  input   An input tensor. Data types supported: U8/QASYMM8/S32/F32.
  65    * @param[in]  indices An indexes tensor. Data types supported: S32.
  66    * @param[out] output  The output tensor, Data types supported: same as @p input.
  67    * @param[in]  axis    (Optional) The axis in @p input to gather @p indices from. Defaults to 0
  68    * @return N/A
  69  */
  70   void configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis = 0);
  71
  72   /**
  73    * @brief Static function to check if given info will lead to a valid configuration
  74    *        of @ref CLGatherEx
  75    * @param[in]  input   An input tensor. Data types supported: U8/QASYMM8/S32/F32.
  76    * @param[in]  indices An indexes tensor. Data types supported: S32.
  77    * @param[out] output  The output tensor, Data types supported: same as @p input.
  78    * @param[in]  axis    (Optional) The axis in @p input to gather @p indices from. Defaults to 0
  79    * @return a status
  80    */
  81   static Status validate(const ITensorInfo *input, const ITensorInfo *indices,
  82                          const ITensorInfo *output, int axis = 0);
  83 };
  84 }
  85 #endif /*__ARM_COMPUTE_CLGATHEREX_H__ */