/*
 * 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.
 */
#ifndef __ARM_COMPUTE_CLPERMUTEEXKERNEL_H__
#define __ARM_COMPUTE_CLPERMUTEEXKERNEL_H__

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

namespace arm_compute
{
class ICLTensor;

/** OpenCL kernel to perform tensor permutation.
 *
 * Permutes given a permutation vector
 */
class CLPermuteExKernel : public ICLKernel
{
public:
  /** Default constructor */
  CLPermuteExKernel();
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CLPermuteExKernel(const CLPermuteExKernel &) = delete;
  /** Prevent instances of this class from being copied (As this class contains pointers) */
  CLPermuteExKernel &operator=(const CLPermuteExKernel &) = delete;
  /** Allow instances of this class to be moved */
  CLPermuteExKernel(CLPermuteExKernel &&) = default;
  /** Allow instances of this class to be moved */
  CLPermuteExKernel &operator=(CLPermuteExKernel &&) = default;
  /** Set the input and output of the kernel.
   *
   * @param[in] input  The input tensor to permute. Data types supported:
   * U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32
   * @param[in] output The output tensor. Data types supported: Same as @p input
   * @param[in] perm   Permutation vector
   */
  void configure(const ICLTensor *input, ICLTensor *output, const PermutationVector &perm);
  /** Static function to check if given info will lead to a valid configuration of @ref
   * CLPermuteKernel
   *
   * @param[in] input  First tensor input info. Data types supported:
   * U8/S8/QASYMM8/U16/S16/F16/U32/S32/F32.
   * @param[in] output Output tensor info. Data types supported: same as @p input.
   * @param[in] perm   Permutation vector
   *
   * @return a status
   */
  static Status validate(const ITensorInfo *input, const ITensorInfo *output,
                         const PermutationVector &perm);

  // Inherited methods overridden:
  void run(const Window &window, cl::CommandQueue &queue) override;

private:
  const ICLTensor *_input;
  ICLTensor *_output;
  PermutationVector _perm;
};
} // arm_compute
#endif /*__ARM_COMPUTE_CLPERMUTEEXKERNEL_H__ */