Tuple<T1, T2, T3, T4>.IStructuralEquatable.Equals Method

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)

Syntax

'Declaration
Private Function Equals ( _
    other As Object, _
    comparer As IEqualityComparer _
) As Boolean Implements IStructuralEquatable.Equals
bool IStructuralEquatable.Equals(
    Object other,
    IEqualityComparer comparer
)

Parameters

  • other
    Type: System.Object
    The object to compare with this instance.

Return Value

Type: System.Boolean
true if the current instance is equal to the specified object; otherwise, false.

Implements

IStructuralEquatable.Equals(Object, IEqualityComparer)

Remarks

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 nulla null reference (Nothing in Visual Basic), 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.

Examples

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.

Imports System.Collections

Public Class Item3And4Comparer(Of T1, T2, T3, T4) : Implements IEqualityComparer

   Private argument As Integer = 0

   Public Overloads Function Equals(ByVal x As Object, ByVal y As Object) As Boolean _
                   Implements IEqualityComparer.Equals
      argument += 1

      ' Return true for all values of Item1, Item2.
      If argument <= 2 Then
         Return True
      Else
         Return x.Equals(y)
      End If
   End Function

   Public Overloads Function GetHashCode(ByVal obj As Object) As Integer _
                    Implements IEqualityComparer.GetHashCode
      If TypeOf obj Is T1 Then
         Return CType(obj, T1).GetHashCode()
      ElseIf TypeOf obj Is T2 Then
         Return CType(obj, T2).GetHashCode()
      ElseIf TypeOf obj Is T3 Then
         Return CType(obj, T3).GetHashCode()
      Else
         Return CType(obj, T4).GetHashCode()
      End If
   End Function
End Class

Module Example
   Public Sub Demo(ByVal outputBlock As System.Windows.Controls.TextBlock)
      Dim temperatures() = _
              { Tuple.Create("New York, NY", 4, 61, 43), _
                Tuple.Create("Chicago, IL", 2, 34, 18), _ 
                Tuple.Create("Newark, NJ", 4, 61, 43), _
                Tuple.Create("Boston, MA", 6, 77, 59), _
                Tuple.Create("Detroit, MI", 9, 74, 53), _
                Tuple.Create("Minneapolis, MN", 8, 81, 61) } 
      ' Compare each item with every other item for equality.
      For ctr As Integer = 0 To temperatures.Length - 1
         Dim temperatureInfo As IStructuralEquatable = temperatures(ctr)
         For ctr2 As Integer = ctr + 1 To temperatures.Length - 1
            outputBlock.Text += String.Format("{0} = {1}: {2}", _
                              temperatureInfo, temperatures(ctr2), _ 
                              temperatureInfo.Equals(temperatures(ctr2), _ 
                                         New Item3And4Comparer(Of String, Integer, Double, Double))) _
                                         + vbCrLf
         Next
         outputBlock.Text &= vbCrLf
      Next
   End Sub
End Module
' The example displays the following output:
'    (New York, NY, 4, 61, 43) = (Chicago, IL, 2, 34, 18): False
'    (New York, NY, 4, 61, 43) = (Newark, NJ, 4, 61, 43): True
'    (New York, NY, 4, 61, 43) = (Boston, MA, 6, 77, 59): False
'    (New York, NY, 4, 61, 43) = (Detroit, MI, 9, 74, 53): False
'    (New York, NY, 4, 61, 43) = (Minneapolis, MN, 8, 81, 61): False
'    
'    (Chicago, IL, 2, 34, 18) = (Newark, NJ, 4, 61, 43): False
'    (Chicago, IL, 2, 34, 18) = (Boston, MA, 6, 77, 59): False
'    (Chicago, IL, 2, 34, 18) = (Detroit, MI, 9, 74, 53): False
'    (Chicago, IL, 2, 34, 18) = (Minneapolis, MN, 8, 81, 61): False
'    
'    (Newark, NJ, 4, 61, 43) = (Boston, MA, 6, 77, 59): False
'    (Newark, NJ, 4, 61, 43) = (Detroit, MI, 9, 74, 53): False
'    (Newark, NJ, 4, 61, 43) = (Minneapolis, MN, 8, 81, 61): False
'    
'    (Boston, MA, 6, 77, 59) = (Detroit, MI, 9, 74, 53): False
'    (Boston, MA, 6, 77, 59) = (Minneapolis, MN, 8, 81, 61): False
'    
'    (Detroit, MI, 9, 74, 53) = (Minneapolis, MN, 8, 81, 61): False
using System;
using System.Collections;

public class Item3And4Comparer<T1, T2, T3, T4> : IEqualityComparer
{
   private int argument = 0;

   new public bool Equals(object x, object y)
   {
      argument++;

      // Return true for all values of Item1, Item2.
      if (argument <= 2)
         return true;
      else
         return x.Equals(y);
   }

   public int GetHashCode(object obj)
   {
      if (obj is T1)
         return ((T1)obj).GetHashCode();
      else if (obj is T2)
         return ((T2)obj).GetHashCode();
      else if (obj is T3)
         return ((T3)obj).GetHashCode();
      else
         return ((T4)obj).GetHashCode();
   }
}

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      Tuple<string, int, double, double>[] temperatures = 
            { Tuple.Create("New York, NY", 4, 61.0, 43.0),
              Tuple.Create("Chicago, IL", 2, 34.0, 18.0), 
              Tuple.Create("Newark, NJ", 4, 61.0, 43.0),
              Tuple.Create("Boston, MA", 6, 77.0, 59.0),
              Tuple.Create("Detroit, MI", 9, 74.0, 53.0),
              Tuple.Create("Minneapolis, MN", 8, 81.0, 61.0) };
      // Compare each item with every other item for equality.
      for (int ctr = 0; ctr < temperatures.Length; ctr++)
      {
         IStructuralEquatable temperatureInfo = temperatures[ctr];
         for (int ctr2 = ctr + 1; ctr2 < temperatures.Length; ctr2++)
            outputBlock.Text += String.Format("{0} = {1}: {2}",
                              temperatureInfo, temperatures[ctr2],
                              temperatureInfo.Equals(temperatures[ctr2],
                                              new Item3And4Comparer<string, int, double, double>())) + "\n";

         outputBlock.Text += "\n";
      }
   }
}
// The example displays the following output:
//    (New York, NY, 4, 61, 43) = (Chicago, IL, 2, 34, 18): False
//    (New York, NY, 4, 61, 43) = (Newark, NJ, 4, 61, 43): True
//    (New York, NY, 4, 61, 43) = (Boston, MA, 6, 77, 59): False
//    (New York, NY, 4, 61, 43) = (Detroit, MI, 9, 74, 53): False
//    (New York, NY, 4, 61, 43) = (Minneapolis, MN, 8, 81, 61): False
//    
//    (Chicago, IL, 2, 34, 18) = (Newark, NJ, 4, 61, 43): False
//    (Chicago, IL, 2, 34, 18) = (Boston, MA, 6, 77, 59): False
//    (Chicago, IL, 2, 34, 18) = (Detroit, MI, 9, 74, 53): False
//    (Chicago, IL, 2, 34, 18) = (Minneapolis, MN, 8, 81, 61): False
//    
//    (Newark, NJ, 4, 61, 43) = (Boston, MA, 6, 77, 59): False
//    (Newark, NJ, 4, 61, 43) = (Detroit, MI, 9, 74, 53): False
//    (Newark, NJ, 4, 61, 43) = (Minneapolis, MN, 8, 81, 61): False
//    
//    (Boston, MA, 6, 77, 59) = (Detroit, MI, 9, 74, 53): False
//    (Boston, MA, 6, 77, 59) = (Minneapolis, MN, 8, 81, 61): False
//    
//    (Detroit, MI, 9, 74, 53) = (Minneapolis, MN, 8, 81, 61): False

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.