// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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.

// Functions for comparing Arrow data structures

#pragma once

#include <cstdint>
#include <iosfwd>
#include <optional>

#include "arrow/util/macros.h"
#include "arrow/util/visibility.h"

namespace arrow {

struct ArrayStatistics;
class Array;
class DataType;
class Tensor;
class SparseTensor;
struct Scalar;

static constexpr double kDefaultAbsoluteTolerance = 1E-5;
static constexpr int32_t kDefaultUlpDistance = 4;

/// A container of options for equality comparisons
class EqualOptions {
 public:
  /// Whether or not NaNs are considered equal.
  bool nans_equal() const { return nans_equal_; }

  /// Return a new EqualOptions object with the "nans_equal" property changed.
  EqualOptions nans_equal(bool v) const {
    auto res = EqualOptions(*this);
    res.nans_equal_ = v;
    return res;
  }

  /// Whether or not zeros with differing signs are considered equal.
  bool signed_zeros_equal() const { return signed_zeros_equal_; }

  /// Return a new EqualOptions object with the "signed_zeros_equal" property changed.
  EqualOptions signed_zeros_equal(bool v) const {
    auto res = EqualOptions(*this);
    res.signed_zeros_equal_ = v;
    return res;
  }

  /// Whether the "atol" property is used in the comparison.
  ///
  /// This option only affects the Equals methods
  /// and has no effect on ApproxEquals methods.
  /// \deprecated Deprecated in 25.0.0. Use arrow::EqualOptions::atol instead
  ARROW_DEPRECATED("Deprecated in 25.0.0. Use arrow::EqualOptions::atol instead")
  bool use_atol() const { return atol_.has_value(); }

  /// Return a new EqualOptions object with the "use_atol" property changed.
  /// \deprecated Deprecated in 25.0.0. Use arrow::EqualOptions::atol instead
  ARROW_DEPRECATED("Deprecated in 25.0.0. Use arrow::EqualOptions::atol instead")
  EqualOptions use_atol(bool v) const {
    auto res = EqualOptions(*this);
    if (v) {
      res.atol_ = atol_.value_or(kDefaultAbsoluteTolerance);
    } else {
      res.atol_ = std::nullopt;
    }
    return res;
  }

  /// The absolute tolerance for approximate comparisons of floating-point values.
  std::optional<double> atol() const { return atol_; }

  /// Return a new EqualOptions object with the "atol" property changed.
  /// If both "ulp_distance" and "atol" are specified, the comparison
  /// succeeds when the "ulp_distance" condition OR the "atol" condition
  /// is satisfied.
  EqualOptions atol(std::optional<double> v) const {
    auto res = EqualOptions(*this);
    res.atol_ = v;
    return res;
  }

  /// The ulp distance for approximate comparisons of floating-point values.
  std::optional<int32_t> ulp_distance() const { return ulp_distance_; }

  /// Return a new EqualOptions object with the "ulp_distance" property changed.
  /// If both "ulp_distance" and "atol" are specified, the comparison
  /// succeeds when the "ulp_distance" condition OR the "atol" condition
  /// is satisfied.
  EqualOptions ulp_distance(std::optional<int32_t> v) const {
    auto res = EqualOptions(*this);
    res.ulp_distance_ = v;
    return res;
  }

  /// Whether the \ref arrow::Schema property is used in the comparison.
  ///
  /// This option only affects the Equals methods
  /// and has no effect on ApproxEquals methods.
  bool use_schema() const { return use_schema_; }

  /// Return a new EqualOptions object with the "use_schema_" property changed.
  ///
  /// Setting this option is false making the value of \ref EqualOptions::use_metadata
  /// is ignored.
  EqualOptions use_schema(bool v) const {
    auto res = EqualOptions(*this);
    res.use_schema_ = v;
    return res;
  }

  /// Whether the "metadata" in \ref arrow::Schema is used in the comparison.
  ///
  /// This option only affects the Equals methods
  /// and has no effect on the ApproxEquals methods.
  ///
  /// Note: This option is only considered when \ref arrow::EqualOptions::use_schema is
  /// set to true.
  bool use_metadata() const { return use_metadata_; }

  /// Return a new EqualOptions object with the "use_metadata" property changed.
  EqualOptions use_metadata(bool v) const {
    auto res = EqualOptions(*this);
    res.use_metadata_ = v;
    return res;
  }

  /// The ostream to which a diff will be formatted if arrays disagree.
  /// If this is null (the default) no diff will be formatted.
  std::ostream* diff_sink() const { return diff_sink_; }

  /// Return a new EqualOptions object with the "diff_sink" property changed.
  /// This option will be ignored if diff formatting of the types of compared arrays is
  /// not supported.
  EqualOptions diff_sink(std::ostream* diff_sink) const {
    auto res = EqualOptions(*this);
    res.diff_sink_ = diff_sink;
    return res;
  }

  static EqualOptions Defaults() { return {}; }

 protected:
  std::optional<double> atol_ = std::nullopt;
  std::optional<int32_t> ulp_distance_ = std::nullopt;
  bool nans_equal_ = false;
  bool signed_zeros_equal_ = true;
  bool use_schema_ = true;
  bool use_metadata_ = false;

  std::ostream* diff_sink_ = NULLPTR;
};

/// Returns true if the arrays are exactly equal
///
/// Note that arrow::ArrayStatistics is not included in the comparison.
ARROW_EXPORT bool ArrayEquals(const Array& left, const Array& right,
                              const EqualOptions& = EqualOptions::Defaults());

/// Returns true if the arrays are approximately equal. For non-floating point
/// types, this is equivalent to ArrayEquals(left, right)
///
/// If the absolute tolerance (atol) is not specified in \ref arrow::EqualOptions,
/// 'arrow::kDefaultAbsoluteTolerance' is used.
///
/// Note that arrow::ArrayStatistics is not included in the comparison.
ARROW_EXPORT bool ArrayApproxEquals(const Array& left, const Array& right,
                                    const EqualOptions& = EqualOptions::Defaults());

/// Returns true if indicated equal-length segment of arrays are exactly equal
///
/// Note that arrow::ArrayStatistics is not included in the comparison.
ARROW_EXPORT bool ArrayRangeEquals(const Array& left, const Array& right,
                                   int64_t start_idx, int64_t end_idx,
                                   int64_t other_start_idx,
                                   const EqualOptions& = EqualOptions::Defaults());

/// Returns true if indicated equal-length segment of arrays are approximately equal
///
/// If the absolute tolerance (atol) is not specified in \ref arrow::EqualOptions,
/// 'arrow::kDefaultAbsoluteTolerance' is used.
///
/// Note that arrow::ArrayStatistics is not included in the comparison.
ARROW_EXPORT bool ArrayRangeApproxEquals(const Array& left, const Array& right,
                                         int64_t start_idx, int64_t end_idx,
                                         int64_t other_start_idx,
                                         const EqualOptions& = EqualOptions::Defaults());

ARROW_EXPORT bool TensorEquals(const Tensor& left, const Tensor& right,
                               const EqualOptions& = EqualOptions::Defaults());

/// EXPERIMENTAL: Returns true if the given sparse tensors are exactly equal
ARROW_EXPORT bool SparseTensorEquals(const SparseTensor& left, const SparseTensor& right,
                                     const EqualOptions& = EqualOptions::Defaults());

/// Returns true if the type metadata are exactly equal
/// \param[in] left a DataType
/// \param[in] right a DataType
/// \param[in] check_metadata whether to compare KeyValueMetadata for child
/// fields
ARROW_EXPORT bool TypeEquals(const DataType& left, const DataType& right,
                             bool check_metadata = true);

/// \brief Check two \ref arrow::ArrayStatistics for equality
/// \param[in] left an \ref arrow::ArrayStatistics
/// \param[in] right an \ref arrow::ArrayStatistics
/// \param[in] options Options used to compare double values for equality.
/// \return True if the two \ref arrow::ArrayStatistics instances are equal; otherwise,
/// false.
ARROW_EXPORT bool ArrayStatisticsEquals(
    const ArrayStatistics& left, const ArrayStatistics& right,
    const EqualOptions& options = EqualOptions::Defaults());

/// Returns true if scalars are equal
/// \param[in] left a Scalar
/// \param[in] right a Scalar
/// \param[in] options comparison options
ARROW_EXPORT bool ScalarEquals(const Scalar& left, const Scalar& right,
                               const EqualOptions& options = EqualOptions::Defaults());

/// Returns true if scalars are approximately equal
///
/// If the absolute tolerance (atol) is not specified in \ref arrow::EqualOptions,
/// 'arrow::kDefaultAbsoluteTolerance' is used.
///
/// \param[in] left a Scalar
/// \param[in] right a Scalar
/// \param[in] options comparison options
ARROW_EXPORT bool ScalarApproxEquals(
    const Scalar& left, const Scalar& right,
    const EqualOptions& options = EqualOptions::Defaults());

}  // namespace arrow
