Enumerable.Union<'TSource> Method (IEnumerable<'TSource>, IEnumerable<'TSource>, IEqualityComparer<'TSource>)
Produces the set union of two sequences by using a specified IEqualityComparer<'T>.
Assembly: System.Core (in System.Core.dll)
static member Union<'TSource> : first:IEnumerable<'TSource> * second:IEnumerable<'TSource> * comparer:IEqualityComparer<'TSource> -> IEnumerable<'TSource>
Parameters
- first
-
Type:
System.Collections.Generic.IEnumerable<'TSource>
An IEnumerable<'T> whose distinct elements form the first set for the union.
- second
-
Type:
System.Collections.Generic.IEnumerable<'TSource>
An IEnumerable<'T> whose distinct elements form the second set for the union.
- comparer
-
Type:
System.Collections.Generic.IEqualityComparer<'TSource>
The IEqualityComparer<'T> to compare values.
Return Value
Type: System.Collections.Generic.IEnumerable<'TSource>An IEnumerable<'T> that contains the elements from both input sequences, excluding duplicates.
Type Parameters
- TSource
The type of the elements of the input sequences.
| Exception | Condition |
|---|---|
| ArgumentNullException | first or second is null. |
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.
If comparer is null, the default equality comparer, Default, is used to compare values.
When the object returned by this method is enumerated, Union<'TSource> enumerates first and second in that order and yields each element that has not already been yielded.
The Concat<'TSource> method differs from the Union<'TSource> method because the Concat<'TSource> method returns all the elements in the input sequences including duplicates, whereas Union<'TSource> returns only unique values.
The following example shows how to implement an equality comparer that can be used in the Union<'TSource> method.
After you implement this comparer, you can use sequences of Product objects in the Union<'TSource> method, as shown in the following example.
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1