java - 复数等于法

Question

我正在用 Java 编写一个复数类，如下所示:

public class Complex {
    public final double real, imag;

    public Complex(double real, double imag) {
        this.real = real;
        this.imag = imag;
    }

    ... methods for arithmetic follow ...
}

我这样实现了 equals 方法:

@Override
public boolean equals(Object obj) {
    if (obj instanceof Complex) {
        Complex other = (Complex)obj;
        return (
            this.real == other.real &&
            this.imag == other.imag
        );
    }
    return false;
}

但是如果您覆盖 equals，您也应该覆盖 hashCode。规则之一是:

If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.

比较 float 和 double 与 == 进行数值比较，所以 +0.0 == -0.0 和 NaN 值不等于所有内容，包括它们自身。所以我尝试实现 hashCode 方法来匹配 equals 方法，如下所示:

@Override
public int hashCode() {
    long real = Double.doubleToLongBits(this.real); // harmonize NaN bit patterns
    long imag = Double.doubleToLongBits(this.imag);
    if (real == 1L << 63) real = 0; // convert -0.0 to +0.0
    if (imag == 1L << 63) imag = 0;
    long h = real ^ imag;
    return (int)h ^ (int)(h >>> 32);
}

但后来我意识到，如果其中一个字段为 NaN，这在 HashMap 中会很奇怪地工作，因为 this.equals(this) 将始终为 false，但也许这不是错误的。另一方面，我可以做 Double 和 Float 做的事情，其中​​ equals 方法比较 +0.0 != -0.0，但仍然协调不同的 NaN 位模式，并让 NaN == NaN，所以我得到:

@Override
public boolean equals(Object obj) {
    if (obj instanceof Complex) {
        Complex other = (Complex)obj;
        return (
            Double.doubleToLongBits(this.real) ==
                Double.doubleToLongBits(other.real) &&
            Double.doubleToLongBits(this.imag) ==
                Double.doubleToLongBits(other.imag)
        );
    }
    return false;
}

@Override
public int hashCode() {
    long h = (
        Double.doubleToLongBits(real) +
        Double.doubleToLongBits(imag)
    );
    return (int)h ^ (int)(h >>> 32);
}

但如果我这样做，那么我的复数就不会表现得像实数，其中 +0.0 == -0.0。但无论如何，我真的不需要将我的复数放在 HashMap 中——我只想做正确的事，遵循最佳实践等。现在我只是感到困惑。任何人都可以建议我继续进行的最佳方式吗？

Answer 1

这个我想多了。问题源于试图平衡 equals 的两种用法:IEEE 754 算术比较和对象/哈希表比较。对于浮点类型，由于 NaN，这两种需求永远无法同时满足。算术比较需要 NaN != NaN，但对象/哈希表比较(equals 方法)需要 this.equals(this)。

Double 根据Object 的约定正确实现方法，所以NaN == NaN。它还执行 +0.0 != -0.0。这两种行为都与原始 float/double 类型的比较相反。

java.util.Arrays.equals(double[], double[]) 比较元素的方式与 Double 相同(NaN == NaN, +0.0 != -0.0).

java.awt.geom.Point2D 在技术上是错误的。它的 equals 方法仅将坐标与 == 进行比较，因此 this.equals(this) 可以为假。同时，它的 hashCode 方法使用 doubleToLongBits，因此即使 equals 返回 true，它的 hashCode 对于两个对象也可以不同。该文档没有提及细微之处，这意味着问题并不重要:人们不会将这些类型的元组放入哈希表中! (如果他们这样做了，效果也不会很好，因为您必须完全得到相同的数字才能得到相同的 key 。)

在像复数类这样的浮点元组中，equals 和 hashCode 最简单的正确实现是完全不覆盖它们。如果您希望方法考虑值，那么正确的做法是 Double 所做的:使用 doubleToLongBits(或 floatToLongBits)在这两种方法中。如果这不适合算术，则需要一个单独的方法；也许 equals(Complex other, double epsilon) 比较数字在公差范围内是否相等。

请注意，您可以覆盖 equals(Complex other) 而不会干扰 equals(Object other)，但这似乎太困惑了。