Enumerable.SequenceEqual(Of TSource) Method (IEnumerable(Of TSource), IEnumerable(Of TSource))

Determines whether two sequences are equal by comparing the elements by using the default equality comparer for their type.

Namespace:  System.Linq
Assembly:  System.Core (in System.Core.dll)

'Declaration
<ExtensionAttribute> _
Public Shared Function SequenceEqual(Of TSource) ( _
	first As IEnumerable(Of TSource), _
	second As IEnumerable(Of TSource) _
) As Boolean

Type Parameters

TSource

The type of the elements of the input sequences.

Parameters

first
Type: System.Collections.Generic.IEnumerable(Of TSource)
An IEnumerable(Of T) to compare to second.
second
Type: System.Collections.Generic.IEnumerable(Of TSource)
An IEnumerable(Of T) to compare to the first sequence.

Return Value

Type: System.Boolean
true if the two source sequences are of equal length and their corresponding elements are equal according to the default equality comparer for their type; otherwise, false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(Of TSource). When you use instance method syntax to call this method, omit the first parameter.

ExceptionCondition
ArgumentNullException

first or second is Nothing.

The SequenceEqual(Of TSource)(IEnumerable(Of TSource), IEnumerable(Of TSource)) method enumerates the two source sequences in parallel and compares corresponding elements by using the default equality comparer for TSource, Default. The default equality comparer, Default, is used to compare values of the types that implement the IEqualityComparer(Of T) generic interface. To compare a custom data type, you need to implement this interface and provide your own GetHashCode and Equals methods for the type.

The following code examples demonstrate how to use SequenceEqual(Of TSource)(IEnumerable(Of TSource), IEnumerable(Of TSource)) to determine whether two sequences are equal. In the first two examples, the method determines whether the compared sequences contain references to the same objects. In the third and fourth examples, the method compares the actual data of the objects within the sequences.

In this example the sequences are equal.


   Class Pet
      Public Name As String
      Public Age As Integer
   End Class

   Sub SequenceEqualEx1()
      ' Create two Pet objects.
      Dim pet1 As New Pet With {.Name = "Turbo", .Age = 2}
      Dim pet2 As New Pet With {.Name = "Peanut", .Age = 8}

      ' Create two lists of pets.
      Dim pets1 As New List(Of Pet)(New Pet() {pet1, pet2})
      Dim pets2 As New List(Of Pet)(New Pet() {pet1, pet2})

      'Determine if the two lists are equal.
      Dim equal As Boolean = pets1.SequenceEqual(pets2)

      ' Display the output.
      Dim text As String = IIf(equal, "are", "are not")
      outputBlock.Text &= "The lists " & text & " equal." & vbCrLf

   End Sub

   ' This code produces the following output:
   '
   ' The lists are equal.



The following code example compares two sequences that are not equal. Note that the sequences contain identical data, but because the objects that they contain have different references, the sequences are not considered equal.


      ' Create two Pet objects.
      Dim pet1 As New Pet With {.Name = "Turbo", .Age = 2}
      Dim pet2 As New Pet With {.Name = "Peanut", .Age = 8}

      ' Create two lists of pets.
      Dim pets1 As New List(Of Pet)()
      pets1.Add(pet1)
      pets1.Add(pet2)

      Dim pets2 As New List(Of Pet)()
      pets2.Add(New Pet With {.Name = "Turbo", .Age = 2})
      pets2.Add(New Pet With {.Name = "Peanut", .Age = 8})

      ' Determine if the two lists are equal.
      Dim equal As Boolean = pets1.SequenceEqual(pets2)

      ' Display the output.
      Dim text As String = IIf(equal, "are", "are not")
      outputBlock.Text &= "The lists " & text & " equal." & vbCrLf

      ' This code produces the following output:
      '
      ' The lists are not equal.



If you want to compare the actual data of the objects in the sequences instead of just comparing their references, you have to implement the IEqualityComparer(Of T) generic interface in your class.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2015 Microsoft