Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Comparing structs for equality without boxing

I came across an extension method that applies to structs (SomeStruct) and returns whether or not the value is equal to the default(SomeStruct) (when the parameterless constructor is called).

public static bool IsDefault<T> (this T value)
    where T : struct
{
    return (!EqualityComparer<T>.Default.Equals(value, default(T)));
}

This got me wondering whether the struct was being boxed. This is purely out of curiosity as there are pros/cons to boxing/passing by value depending on the context.

Assumptions:

  1. The first of the following methods is illegal since structs do not implicitly override the equality operators ==/!=.
  2. The second "appears" to avoid boxing.
  3. The third method should always box the struct since it's calling object.Equals(object o).
  4. The fourth has both overloads available (object/T) so I'm assuming it will avoid boxing as well. However, the target struct would need to implement the IEquatable<T> interface, making the helper extension method not very helpful.

Variations:

public static bool IsDefault<T> (this T value)
    where T : struct
{
    // Illegal since there is no way to know whether T implements the ==/!= operators.
    return (value == default(T));
}

public static bool IsDefault<T> (this T value)
    where T : struct
{
    return (!EqualityComparer<T>.Default.Equals(value, default(T)));
}

public static bool IsDefault<T> (this T value)
    where T : struct
{
    return (value.Equals(default(T)));
}

public static bool IsDefault<T> (this T value)
    where T : struct, IEquatable<T>
{
    return (value.Equals(default(T)));
}

This question is about confirming the above assumptions and if I am misunderstanding and/or leaving something out.

like image 651
Raheel Khan Avatar asked Apr 24 '16 11:04

Raheel Khan


2 Answers

  1. The first of the following methods is illegal since structs do not implicitly override the equality operators ==/!=.

True.

  1. The second "appears" to avoid boxing.

The signature of the called method is EqualityComparer<T>.Equals(T,T) which uses the type T for the parameters, so it does not require boxing to call.

The implementation of the default comparer checks if T is IEquatable<T> and if so uses a comparer that uses IEquatable<T>.Equals and else uses a comparer for Object.Equals, so internally there might be boxing applied if the struct is not IEquatable ('only if needed').

  1. The third method should always box the struct since it's calling object.Equals(object o).

True.

  1. The fourth has both overloads available (object/T) so I'm assuming it will avoid boxing as well. However, the target struct would need to implement the IEquatable interface, making the helper extension method not very helpful.

Yes, it does not require boxing, as per this SO answer. This is the effective code you get for the specific case of T : IEquatable from the EqualityComparer<T>.Default.

like image 170
MicroVirus Avatar answered Oct 31 '22 15:10

MicroVirus


Let me add that for structs, if you do not define comparations, the details get complicated.

For example How to define value equality for a type says:

Any struct that you define already has a default implementation of value equality that it inherits from the System.ValueType override of the Object.Equals(Object) method. This implementation uses reflection to examine all the fields and properties in the type. Although this implementation produces correct results, it is relatively slow compared to a custom implementation that you write specifically for the type.

See also Performance implications of default struct equality in C# for more details, including:

There is an optimized default version for Equals and GetHashCode but you should never rely on it because you may stop hitting it with an innocent code change.

like image 43
Pablo H Avatar answered Oct 31 '22 13:10

Pablo H