IStructuralEquatable和IStructuralComparable解决了什么问题?

时间:2010-08-31 14:09:45

标签: .net equality icomparable iequalitycomparer

我注意到这两个接口,以及几个相关的类,已经在.NET 4中添加了。它们对我来说似乎有点多余;我已经阅读了几个关于它们的博客,但我仍然无法弄清楚它们在.NET 4之前解决了哪些问题。

IStructuralEquatableIStructuralComparable有什么用?

6 个答案:

答案 0 :(得分:45)

.NET中的所有类型都支持Object.Equals()方法,默认情况下,该方法会比较 引用相等 的两种类型。但是,有时候,还希望能够比较两种类型 结构平等

最好的例子是数组,.NET 4现在实现了IStructuralEquatable接口。这使得可以区分是比较两个数组以获得引用相等性,还是比较“结构相等性” - 它们是否具有相同数量的项目,每个位置具有相同的值。这是一个例子:

int[] array1 = new int[] { 1, 5, 9 };
int[] array2 = new int[] { 1, 5, 9 };

// using reference comparison...
Console.WriteLine( array1.Equals( array2 ) ); // outputs false

// now using the System.Array implementation of IStructuralEquatable
Console.WriteLine( StructuralComparisons.StructuralEqualityComparer.Equals( array1, array2 ) ); // outputs true

实现结构平等/可比性的其他类型包括元组和匿名类型 - 它们都明显受益于基于其结构和内容执行比较的能力。

你没有问的问题是:

  

为什么我们已经有IStructuralComparableIStructuralEquatable   存在IComparableIEquatable接口?

我要提出的答案是,一般来说,需要区分参考比较和结构比较。通常情况下,如果您实施IEquatable<T>.Equals,您也会覆盖Object.Equals以保持一致。在这种情况下,您如何支持参考和结构相等?

答案 1 :(得分:15)

我有同样的问题。当我运行LBushkin的例子时,我惊讶地发现我得到了不同的答案!虽然这个答案有8个赞成票,但这是错误的。经过大量的“反思”之后,这是我对事物的看法。

某些容器(数组,元组,匿名类型)支持IStructuralComparable和IStructuralEquatable。

IStructuralComparable支持深度,默认排序 IStructuralEquatable支持深度默认哈希。

{注意EqualityComparer<T>支持浅(仅1个容器级别),默认哈希。}

据我所知,这只是通过StructuralComparisons类公开的。我能弄清楚这个有用的唯一方法是制作一个StructuralEqualityComparer<T>辅助类,如下所示:

    public class StructuralEqualityComparer<T> : IEqualityComparer<T>
    {
        public bool Equals(T x, T y)
        {
            return StructuralComparisons.StructuralEqualityComparer.Equals(x,y);
        }

        public int GetHashCode(T obj)
        {
            return StructuralComparisons.StructuralEqualityComparer.GetHashCode(obj);
        }

        private static StructuralEqualityComparer<T> defaultComparer;
        public static StructuralEqualityComparer<T> Default
        {
            get
            {
                StructuralEqualityComparer<T> comparer = defaultComparer;
                if (comparer == null)
                {
                    comparer = new StructuralEqualityComparer<T>();
                    defaultComparer = comparer;
                }
                return comparer;
            }
        }
    }

现在我们可以创建一个HashSet,其中包含容器内容器的容器。

        var item1 = Tuple.Create(1, new int[][] { new int[] { 1, 2 }, new int[] { 3 } });
        var item1Clone = Tuple.Create(1, new int[][] { new int[] { 1, 2 }, new int[] { 3 } });
        var item2 = Tuple.Create(1, new int[][] { new int[] { 1, 3 }, new int[] { 3 } });

        var set = new HashSet<Tuple<int, int[][]>>(StructuralEqualityComparer<Tuple<int, int[][]>>.Default);
        Console.WriteLine(set.Add(item1));      //true
        Console.WriteLine(set.Add(item1Clone)); //false
        Console.WriteLine(set.Add(item2));      //true

我们还可以通过实现这些接口使我们自己的容器与这些其他容器很好地配合。

public class StructuralLinkedList<T> : LinkedList<T>, IStructuralEquatable
    {
        public bool Equals(object other, IEqualityComparer comparer)
        {
            if (other == null)
                return false;

            StructuralLinkedList<T> otherList = other as StructuralLinkedList<T>;
            if (otherList == null)
                return false;

            using( var thisItem = this.GetEnumerator() )
            using (var otherItem = otherList.GetEnumerator())
            {
                while (true)
                {
                    bool thisDone = !thisItem.MoveNext();
                    bool otherDone = !otherItem.MoveNext();

                    if (thisDone && otherDone)
                        break;

                    if (thisDone || otherDone)
                        return false;

                    if (!comparer.Equals(thisItem.Current, otherItem.Current))
                        return false;
                }
            }

            return true;
        }

        public int GetHashCode(IEqualityComparer comparer)
        {
            var result = 0;
            foreach (var item in this)
                result = result * 31 + comparer.GetHashCode(item);

            return result;
        }

        public void Add(T item)
        {
            this.AddLast(item);
        }
    }

现在我们可以在容器内的自定义容器中创建包含容器的项目的HashSet。

        var item1 = Tuple.Create(1, new StructuralLinkedList<int[]> { new int[] { 1, 2 }, new int[] { 3 } });
        var item1Clone = Tuple.Create(1, new StructuralLinkedList<int[]> { new int[] { 1, 2 }, new int[] { 3 } });
        var item2 = Tuple.Create(1, new StructuralLinkedList<int[]> { new int[] { 1, 3 }, new int[] { 3 } });

        var set = new HashSet<Tuple<int, StructuralLinkedList<int[]>>>(StructuralEqualityComparer<Tuple<int, StructuralLinkedList<int[]>>>.Default);
        Console.WriteLine(set.Add(item1));      //true
        Console.WriteLine(set.Add(item1Clone)); //false
        Console.WriteLine(set.Add(item2));      //true

答案 2 :(得分:3)

这是另一个示例,说明了两个接口的可能用法:

var a1 = new[] { 1, 33, 376, 4};
var a2 = new[] { 1, 33, 376, 4 };
var a3 = new[] { 2, 366, 12, 12};

Debug.WriteLine(a1.Equals(a2)); // False
Debug.WriteLine(StructuralComparisons.StructuralEqualityComparer.Equals(a1, a2)); // True

Debug.WriteLine(StructuralComparisons.StructuralComparer.Compare(a1, a2)); // 0
Debug.WriteLine(StructuralComparisons.StructuralComparer.Compare(a1, a3)); // -1

答案 3 :(得分:1)

IStructuralEquatable Interface的描述中,微软明确表示(在“备注”部分):

  

使用IStructuralEquatable界面可以实现自定义比较,以检查集合对象的结构相等性。

此接口位于System.Collections名称空间。

这一点也清楚地表明了这一点

答案 4 :(得分:0)

F#从.net 4.(.net 2 is here

开始使用它们

这些界面对F#

至关重要
let list1 = [1;5;9] 
let list2 = List.append [1;5] [9]

printfn "are they equal? %b" (list1 = list2)

list1.GetType().GetInterfaces().Dump()

enter image description here

答案 5 :(得分:0)

C# in a nutshell书:

  

因为数组是一个类,所以数组总是(自己)reference types,无论   数组的元素类型这意味着语句arrayB = arrayA的结果   在引用同一数组的两个变量中。同样,两个不同的数组将   始终会通过相等性测试-除非您使用自定义的相等比较器。构架   4.0引入了一种用于比较数组中元素的目的,您可以   通过StructuralComparisons类型访问。

object[] a1 = { "string", 123, true};
object[] a2 = { "string", 123, true};

Console.WriteLine(a1 == a2);               // False
Console.WriteLine(a1.Equals(a2));          // False

IStructuralEquatable se1 = a1;
Console.WriteLine(se1.Equals(a2, StructuralComparisons.StructuralEqualityComparer));    // True
Console.WriteLine(StructuralComparisons.StructuralEqualityComparer.Equals(a1, a2));     // True

object[] a3 = {"string", 123, true};
object[] a4 = {"string", 123, true};
object[] a5 = {"string", 124, true};

IStructuralComparable se2 = a3;
Console.WriteLine(se2.CompareTo(a4, StructuralComparisons.StructuralComparer));    // 0
Console.WriteLine(StructuralComparisons.StructuralComparer.Compare(a3, a4));       // 0
Console.WriteLine(StructuralComparisons.StructuralComparer.Compare(a4, a5));       // -1
Console.WriteLine(StructuralComparisons.StructuralComparer.Compare(a5, a4));       // 1