summaryrefslogtreecommitdiff
path: root/runtimes/libs/ARMComputeEx/arm_compute/core/CL/kernels/CLGatherExKernel.h
blob: aa81a1efa7d5fcf3b7d058b829357d2381504362 (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
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 * Copyright (c) 2016-2018 ARM Limited.
 *
 * 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.
 */

/**
 * @file      CLGatherExKernel.h
 * @ingroup   COM_AI_RUNTIME
 * @brief     This file defines CLGatherExKernel class
 */

#ifndef __ARM_COMPUTE_CLGATHEREXKERNEL_H__
#define __ARM_COMPUTE_CLGATHEREXKERNEL_H__

#include "arm_compute/core/CL/ICLKernel.h"

namespace arm_compute
{
class ICLTensor;

/**
 * @brief Class to define an interface for the gather kernel.
 */
class CLGatherExKernel : public ICLKernel
{
public:
  /**
   * @brief Construct CLGatherExKernel object
   * */
  CLGatherExKernel();

  /**
   * @brief Prevent instances of this class from being copied (As this class contains pointers).
   */
  CLGatherExKernel(const CLGatherExKernel &) = delete;

  /**
   * @brief Prevent instances of this class from being copied (As this class contains pointers).
   */
  CLGatherExKernel &operator=(const CLGatherExKernel &) = delete;

  /**
   * @brief Construct CLGatherExKernel object by using default move constructor
   * @param[in] CLGatherExKernel object to move
   */
  CLGatherExKernel(CLGatherExKernel &&) = default;

  /**
   * @brief Move assignment operator
   * @param[in] CLGatherExKernel object to move
   */
  CLGatherExKernel &operator=(CLGatherExKernel &&) = default;

  /**
   * @brief Initialise the kernel's input, output and border mode.
   * @param[in]  input           An input tensor. Data types supported: U8/QASYMM8/S32/F32.
   * @param[in]  indices         Indices tensor. Data types supported: S32.
   * @param[out] output          The output tensor, Data types supported: same as @p input1.
   * @param[in]  axis            (Optional) The axis in @p input to gather @p indices from. Negative
   * values wrap around. Defaults to 0
   * @return N/A
   */
  void configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis = 0);

  /**
   * @brief Static function to check if given info will lead to a valid configuration of @ref
   * CLGatherExKernel
   * @param[in]  input           An input tensor. Data types supported: U8/QASYMM8/S32/F32.
   * @param[in]  indices         Indices tensor. Data types supported: S32.
   * @param[out] output          The output tensor, Data types supported: same as @p input1.
   * @param[in]  axis            (Optional) The axis in @p input to gather @p indices from. Negative
   * values wrap around. Defaults to 0
   * @return a status
   */
  static Status validate(const ITensorInfo *input, const ITensorInfo *indices,
                         const ITensorInfo *output, int axis = 0);

  /**
   * @brief Enqueue the OpenCL kernel to process the given window on the passed OpenCL command
   *        queue.
   * @note  The queue is *not* flushed by this method, and therefore the kernel will not have
   *        been executed by the time this method returns.
   * @param[in] window      Region on which to execute the kernel. (Must be a valid region of
   *                        the window returned by window()).
   * @param[in,out] queue   Command queue on which to enqueue the kernel.@return N/A
   * @return N/A
   */
  void run(const Window &window, cl::CommandQueue &queue) override;

private:
  const ICLTensor *_input;
  const ICLTensor *_indices;
  ICLTensor *_output;
  int _axis;
};
} // namespace arm_compute
#endif /*__ARM_COMPUTE_CLGATHEREXKERNEL_H__ */