What is the most optimal way to use a C# struct as the key of a dictionary?

Question

I have a C# struct which I use as the key in a standard Dictionary collection. I've written overrides for both its GetHashCode and Equals, but I'm a little unhappy that Equals is given a boxed object instead of a reference to my struct type directly.

Is there anything I can do to optimize my use of Dictionary with my struct type to avoid the unnecessary boxing operation?

(This isn't premature optimization but entirely appropriate optimization, thank you very much.)

https://stackoverflow.com/questions/13262106/dictionary-containskey-how-does-it-work — user6144226, Aug 24 '17 at 08:35

Tim Schmelter · Accepted Answer · 2017-08-24T08:38:07.153

You could implement a generic comparer:

public class MyStructComparer : IEqualityComparer<MyStruct>
{
    public bool Equals(MyStruct x, MyStruct y)
    {
        // ...
    }
    public int GetHashCode(MyStruct obj)
    {
        // ...
    }
}

Then use that for the dictionary constructor:

var myStructDict = new Dictionary<MyStruct, string>(new MyStructComparer());

Another way is to implement IEquatable<MyStruct> in MyStruct, for example:

public struct MyStruct: IEquatable<MyStruct>
{
    public int Id;

    public override bool Equals(object obj)
    {
        if (ReferenceEquals(null, obj)) return false;
        return obj is MyStruct && Equals((MyStruct)obj);
    }

    public bool Equals(MyStruct other)
    {
        return this.Id == other.Id;
    }

    public override int GetHashCode()
    {
        return this.Id;
    }
}

Then the dictionary can be initialized with the default constructor:

var myStructDict = new Dictionary<MyStruct, string>();

score 0 · Answer 2 · answered Aug 24 '17 at 08:52

You may also try for operator over loading. check the code below.

struct MyStruct
    {
        public int id;

        public static bool operator ==(MyStruct s1, MyStruct s2)
        {
            if (s1.id == s2.id)
                return true;
            return false;
        }

        public static bool operator !=(MyStruct s1, MyStruct s2)
        {
            if (s1.id == s2.id)
                return false;
            return true;
        }

        public override bool Equals(object obj)
        {
            if (ReferenceEquals(null, obj)) return false;
            return obj is MyStruct && Equals((MyStruct)obj);
        }

        public bool Equals(MyStruct other)
        {
            return this.id == other.id;
        }

        public override int GetHashCode()
        {
            return this.id;
        }
    }

operators ==/!= are never used for comprasion in Dictionary according to reference source — user6144226, Aug 24 '17 at 09:01

What is the most optimal way to use a C# struct as the key of a dictionary?

2 Answers2