Manuel Bottini | 8529bd6 | 2018-11-21 11:53:04 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018-2019 ARM Limited. |
| 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
| 24 | |
| 25 | #ifndef __ARM_COMPUTE_CLGATHER_H__ |
| 26 | #define __ARM_COMPUTE_CLGATHER_H__ |
| 27 | |
| 28 | #include "arm_compute/runtime/CL/ICLSimpleFunction.h" |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | class ICLTensor; |
| 33 | |
| 34 | /** Basic function to run @ref CLGatherKernel */ |
| 35 | class CLGather : public ICLSimpleFunction |
| 36 | { |
| 37 | public: |
| 38 | /** Initialise the kernel's inputs and outputs |
| 39 | * |
| 40 | * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32 |
Manuel Bottini | 7ad6257 | 2019-01-16 11:18:15 +0000 | [diff] [blame] | 41 | * @param[in] indices Indices tensor. Supported tensor rank: up to 1. Must be one of the following types: U32/S32. Each value must be in range [0, input.shape[@p axis]) |
Manuel Bottini | 8529bd6 | 2018-11-21 11:53:04 +0000 | [diff] [blame] | 42 | * @param[out] output Destination tensor. Data type supported: Same as @p input |
| 43 | * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Defaults to 0 |
| 44 | */ |
| 45 | void configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis = 0); |
| 46 | |
| 47 | /** Static function to check if given info will lead to a valid configuration of @ref CLGatherKernel |
| 48 | * |
| 49 | * @param[in] input Source tensor info. Supported tensor rank: up to 4. Data type supported: U8/S8/QASYMM8/U16/S16/U32/S32/F16/F32 |
Manuel Bottini | 7ad6257 | 2019-01-16 11:18:15 +0000 | [diff] [blame] | 50 | * @param[in] indices Indices tensor info. Supported tensor rank: up to 4. Must be one of the following types: U32/S32. Each value must be in range [0, input.shape[@p axis]) |
Manuel Bottini | 8529bd6 | 2018-11-21 11:53:04 +0000 | [diff] [blame] | 51 | * @param[in] output Destination tensor info. Data type supported: Same as @p input |
| 52 | * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Defaults to 0 |
| 53 | * |
| 54 | * @return a status |
| 55 | */ |
| 56 | static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis = 0); |
| 57 | }; |
| 58 | } // namespace arm_compute |
| 59 | #endif /* __ARM_COMPUTE_CLGATHER_H__ */ |