summaryrefslogtreecommitdiff
path: root/compute/ARMComputeEx/arm_compute/runtime/CL/functions/CLGatherEx.h
blob: b01ec42550b65badacdf70ef3046e01821691852 (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
/*
 * Copyright (c) 2018 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) 2016-2018 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.
 */

/**
 * @file CLGatherEx.h
 * @brief       This file contains CLGatherEx class
 * @ingroup     COM_AI_RUNTIME
 */

#ifndef __ARM_COMPUTE_CLGATHEREX_H__
#define __ARM_COMPUTE_CLGATHEREX_H__

#include "arm_compute/runtime/CL/ICLSimpleFunction.h"

namespace arm_compute
{
class ICLTensor;

/**
 * @brief Class to to run @ref CLGatherKernel.
 */
class CLGatherEx : public ICLSimpleFunction
{
public:
  /**
   * @brief Initialise the kernel's inputs, output and convertion policy.
   * @param[in]  input   An input tensor. Data types supported: U8/QASYMM8/S32/F32.
   * @param[in]  indices An indexes tensor. Data types supported: S32.
   * @param[out] output  The output tensor, Data types supported: same as @p input.
   * @param[in]  axis    (Optional) The axis in @p input to gather @p indices from. 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 CLGatherEx
   * @param[in]  input   An input tensor. Data types supported: U8/QASYMM8/S32/F32.
   * @param[in]  indices An indexes tensor. Data types supported: S32.
   * @param[out] output  The output tensor, Data types supported: same as @p input.
   * @param[in]  axis    (Optional) The axis in @p input to gather @p indices from. Defaults to 0
   * @return a status
   */
  static Status validate(const ITensorInfo *input, const ITensorInfo *indices,
                         const ITensorInfo *output, int axis = 0);
};
}
#endif /*__ARM_COMPUTE_CLGATHEREX_H__ */