C# equality comparison fails

Question

I am having trouble with the equality comparison via IEquatable<> in the following class I wrote:

public class Bead: IEquatable<Bead>
{
    public string Name { get; set; }
    public Point2d Location { get; private set; }

    public void SetLocation(Point2d newLocation)
    {
        Location = newLocation;
    }

    #region equality comparison
    /// <summary>
    /// Equality comparisons
    /// </summary>
    /// <param name="other"></param>
    /// <returns></returns>
    public override bool Equals(object other)
    {
        if (!(other is Bead)) return false;
        return Equals((Bead)other); // Calls method below
    }
    public bool Equals(Bead other) // Implements IEquatable<Point2d>
    {
        return Location == other.Location && Name == other.Name;
    }
    public override int GetHashCode()
    {
        return this.Location.GetHashCode() * 67 + Name.GetHashCode(); // 67 = some prime number
    }
    public static bool operator ==(Bead a1, Bead a2)
    {
        if (a1 == null && a2 == null) return true;
        if (a1 == null || a2 == null) return false;
        return a1.Equals(a2);
    }
    public static bool operator !=(Bead a1, Bead a2)
    {
        if (a1 == null || a2 == null) return true;
        if (a1 == null && a2 == null) return false;
        return !a1.Equals(a2);
    } 
    #endregion
}

An unhandled exception of type 'System.StackOverflowException' occurred in PolymerMotionSimulation.exe

How can I solve this?

Answer 1

Your == operator calls itself, leading to infinite recursion. To check if an object is a null reference, better use is null or ReferenceEquals(a1, null) :

public static bool operator ==(Bead a1, Bead a2)
{
    if (a1 is null && a2 is null) return true;
    if (a1 is null || a2 is null) return false;
    return a1.Equals(a2);
}

and similary for != .

Or:

public static bool operator ==(Bead a1, Bead a2)
{
    if (ReferenceEquals(a1, null) && ReferenceEquals(a2, null)) return true;
    if (ReferenceEquals(a1, null) || ReferenceEquals(a2, null)) return false;
    return a1.Equals(a2);
}