What problem does IStructuralEquatable and IStructuralComparable solve?

by

All types in .NET support the Object.Equals() method which, by default, compares two types for reference equality. However, sometimes, it also desirable to be able to compare two types for structural equality.

The best example of this is arrays, which with .NET 4 now implement the IStructuralEquatable interface. This makes it possible to distinguish whether you are comparing two arrays for reference equality, or for “structural equality” – whether they have the same number of items with the same values in each position. Here’s an example:

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

Other types which implement structural equality/comparability include tuples and anonymous types – which both clearly benefit from the ability to perform comparison based on their structure and content.

A question you didn’t ask is:

Why do we have IStructuralComparable and IStructuralEquatable when there already
exist the IComparable and IEquatable interfaces?

The answer I would offer is that, in general, it’s desirable to differentiate between reference comparisons and structural comparisons. It’s normally expected that if you implement IEquatable<T>.Equals you will also override Object.Equals to be consistent. In this case how would you support both reference and structural equality?

More Related Contents:

  1. Comparing two collections for equality irrespective of the order of items in them
  2. When to use IComparable Vs. IComparer
  3. How do I use WPF bindings with RelativeSource?
  4. ControlTemplate for existing controls in WPF
  5. How do you configure an OpenFileDialog to select folders?
  6. What is the point of DBNull?
  7. Single objects still limited to 2 GB in size in CLR 4.0?
  8. How to change stack size for a .NET program?
  9. What’s the difference between IEquatable and just overriding Object.Equals()?
  10. How Random is System.Guid.NewGuid()? (Take two)
  11. How do I read a disk directly with .Net?
  12. Why is the Visual Studio 2015/2017/2019 Test Runner not discovering my xUnit v2 tests
  13. Custom app.config Config Section Handler
  14. Cannot send a content-body with this verb-type
  15. Generate POCO classes in different project to the project with Entity Framework model
  16. Where and how is the _ViewStart.cshtml layout file linked?
  17. How to clear the cache of HttpWebRequest
  18. Referencing Google’s V8 engine from a .NET app
  19. Error message “Unable to install or run the application. The application requires stdole Version 7.0.3300.0 in the GAC”
  20. Windows 7 .net Excel .SaveAs() Error Exception from HRESULT: 0x800A03EC
  21. ASP.NET MVC 3 Model Binding Resources
  22. How can I get a ListView GridViewColumn to fill the remaining space in my grid?
  23. “The calling thread must be STA, because many UI components require this” error when creating a WPF pop-up Window in thread
  24. Translate a column index into an Excel Column Name
  25. How to log MethodName when wrapping Log4net?
  26. Drag and drop a DLL to the GAC (“assembly”) in windows server 2008 .net 4.0
  27. Get a list of groups that Azure AD user belongs to in claims
  28. Are nested Try/Catch blocks a bad idea?
  29. Determine whether .NET assemblies were built from the same source
  30. String.Split VS. Regex.Split?

Leave a Comment