Tuple<'T1, 'T2, 'T3, 'T4>.IStructuralEquatable.Equals Method (Object, IEqualityComparer)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a value that indicates whether the current Tuple<'T1, 'T2, 'T3, 'T4> object is equal to a specified object based on a specified comparison method.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

private abstract Equals : 
        other:Object *
        comparer:IEqualityComparer -> bool
private override Equals : 
        other:Object *
        comparer:IEqualityComparer -> bool


Type: System.Object

The object to compare with this instance.

Type: System.Collections.IEqualityComparer

An object that defines the method to use to evaluate whether the two objects are equal.

Return Value

Type: System.Boolean

true if the current instance is equal to the specified object; otherwise, false.

This member is an explicit interface member implementation. It can be used only when the Tuple<'T1, 'T2, 'T3, 'T4> instance is cast to an IStructuralEquatable interface.

The IEqualityComparer.Equals implementation is called only if other is not null, and if it can be successfully cast (in C#) or converted (in Visual Basic) to a Tuple<'T1, 'T2, 'T3, 'T4> object whose components are of the same types as the current instance. The IStructuralEquatable.Equals(Object, IEqualityComparer) method first passes the Item1 values of the Tuple<'T1, 'T2, 'T3, 'T4> objects to be compared to the IEqualityComparer.Equals implementation. If this method call returns true, the method is called again and passed the Item2 values of the two Tuple<'T1, 'T2, 'T3, 'T4> objects. If this method call returns true again, the method is called a third time and passed the Item3 values of the two Tuple<'T1, 'T2, 'T3, 'T4> objects. If this method call returns true again, the method is called for the fourth and final time and passed the Item4 values of the two Tuple<'T1, 'T2, 'T3, 'T4> objects.

The following example defines an Item3And4Comparer class that implements the IEqualityComparer interface and changes the way in which Tuple<'T1, 'T2, 'T3, 'T4> objects are evaluated for equality. The method always returns true when it is passed the Item1 and Item2 property values of two Tuple<'T1, 'T2, 'T3, 'T4> objects, and it calls the obj.Equals method to evaluate their Item3 property values. It this method call returns true, it also calls the obj.Equals method to evaluate the tuples' Item4 property values. As a result, the method tests for equality based only on the values of the Item3 and Item4 properties. The output illustrates the result for a data set of Tuple<'T1, 'T2, 'T3, 'T4> objects that record the name of a U.S. city, the month of a year, and the average high and low temperature for that month.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Available since 4.0
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top