Class EqualOptions

cpp/src/arrow/compare.h:40–142

A container of options for equality comparisons

/// 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.
  bool use_atol() const { return use_atol_; }

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

  /// The absolute tolerance for approximate comparisons of floating-point values.
  /// Note that this option is ignored if "use_atol" is set to false.
  double atol() const { return atol_; }

  /// Return a new EqualOptions object with the "atol" property changed.
  EqualOptions atol(double v) const {
    auto res = EqualOptions(*this);
    res.atol_ = 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);