/*
 * 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 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__ */