Share via

  • Article

Enumerable.Zip<TFirst, TSecond, TResult> Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Merges two sequences by using the specified predicate function.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Zip(Of TFirst, TSecond, TResult) ( _
    first As IEnumerable(Of TFirst), _
    second As IEnumerable(Of TSecond), _
    resultSelector As Func(Of TFirst, TSecond, TResult) _
) As IEnumerable(Of TResult)

public static IEnumerable<TResult> Zip<TFirst, TSecond, TResult>(
    this IEnumerable<TFirst> first,
    IEnumerable<TSecond> second,
    Func<TFirst, TSecond, TResult> resultSelector
)

Type Parameters

  • TFirst
    The type of the elements of the first input sequence.
  • TSecond
    The type of the elements of the second input sequence.
  • TResult
    The type of the elements of the result sequence.

Parameters

  • resultSelector
    Type: System.Func<TFirst, TSecond, TResult>
    A function that specifies how to merge the elements from the two sequences.

Return Value

Type: System.Collections.Generic.IEnumerable<TResult>
An IEnumerable<T> that contains merged elements of two input sequences.

Usage Note

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

Exceptions

Exception Condition
ArgumentNullException

first or second is nulla null reference (Nothing in Visual Basic).

Remarks

This method is implemented by using deferred execution. The immediate return value is an object that stores all the information that is required to perform the action. The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

The method merges each element of the first sequence with an element that has the same index in the second sequence. If the sequences do not have the same number of elements, the method merges sequences until it reaches the end of one of them. For example, if one sequence has three elements and the other one has four, the result sequence will have only three elements.

Examples

The following code example demonstrates how to use the Zip<TFirst, TSecond, TResult> method to merge two sequences.

Dim numbers() As Integer = {1, 2, 3, 4}
Dim words() As String = {"one", "two", "three"}
Dim numbersAndWords = numbers.Zip(words, Function(first, second) first & " " & second)

For Each item In numbersAndWords
   outputBlock.Text &= item & vbCrLf
Next

' This code produces the following output:

' 1 one
' 2 two
' 3 three

      int[] numbers = { 1, 2, 3, 4 };
      string[] words = { "one", "two", "three" };

      var numbersAndWords = numbers.Zip(words, (first, second) => first + " " + second);

      foreach (var item in numbersAndWords)
         outputBlock.Text += item + "\n";

      // This code produces the following output:

      // 1 one
      // 2 two
      // 3 three

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.