/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 * Copyright (c) 2018-2019 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.
 */
#ifndef __ARM_COMPUTE_NEBINARYLOGICALOPERATION_H__
#define __ARM_COMPUTE_NEBINARYLOGICALOPERATION_H__

#include "arm_compute/core/TypesEx.h"
#include "arm_compute/runtime/NEON/INESimpleFunction.h"

namespace arm_compute
{
class ITensor;

/** Basic function to run @ref NEBinaryLogicalOperationKernel.
 *
 * @note The tensor data type for the inputs must be QASYMM8/U8.
 * @note The function performs a binary logical operation between two tensors.
 */
class NEBinaryLogicalOperation : public INESimpleFunction
{
public:
  /** Initialise the kernel's inputs, output and conversion policy.
   *
   * @param[in, out] input1 First tensor input. Data types supported: QASYMM8/U8.
   * @param[in, out] input2 Second tensor input. Data types supported: Same as @p input1.
   * @param[out]     output Output tensor. Data types supported: Same as @p input1.
   * @param[in]      op     Binary Logical Operation to be performed.
   */
  void configure(ITensor *input1, ITensor *input2, ITensor *output, BinaryLogicalOperation op);
  /** Static function to check if given info will lead to a valid configuration of @ref
   * NEBinaryLogicalOperationKernel
   *
   * @param[in] input1 First tensor input info. Data types supported: QASYMM8/U8.
   * @param[in] input2 Second tensor input info. Data types supported: Same as @p input1.
   * @param[in] output Output tensor info. Data types supported: Same as @p input1.
   * @param[in] op     Binary Logical Operation to be performed.
   *
   * @return a status
   */
  static Status validate(const ITensorInfo *input1, const ITensorInfo *input2,
                         const ITensorInfo *output, BinaryLogicalOperation op);
};

/** Basic function to run @ref NEBinaryLogicalOperationKernel
 *
 * @note The tensor data type for the inputs must be QASYMM8/U8.
 * @note The function performs a binary logical operation between two tensors.
 */
template <BinaryLogicalOperation op> class NEBinaryLogicalOperationStatic : public INESimpleFunction
{
public:
  /** Initialise the kernel's inputs, output and conversion policy.
   *
   * @param[in, out] input1 First tensor input. Data types supported: QASYMM8/U8
   * @param[in, out] input2 Second tensor input. Data types supported: Same as @p input1.
   * @param[out]     output Output tensor. Data types supported: Same as @p input1.
   */
  void configure(ITensor *input1, ITensor *input2, ITensor *output);
  /** Static function to check if given info will lead to a valid configuration of @ref
   * NEBinaryLogicalOperationKernel
   *
   * @param[in] input1 First tensor input info. Data types supported: QASYMM8/U8
   * @param[in] input2 Second tensor input info. Data types supported: Same as @p input1.
   * @param[in] output Output tensor info. Data types supported: Same as @p input1.
   *
   * @return a status
   */
  static Status validate(const ITensorInfo *input1, const ITensorInfo *input2,
                         const ITensorInfo *output);
};

/** Basic function to run equal comparison. */
using NELogicalAnd = NEBinaryLogicalOperationStatic<BinaryLogicalOperation::AND>;
/** Basic function to run not equal comparison. */
using NELogicalOr = NEBinaryLogicalOperationStatic<BinaryLogicalOperation::OR>;
} // namespace arm_compute
#endif /* __ARM_COMPUTE_NEBINARYLOGICALOPERATION_H__ */