Enumerable.Union<TSource> Method (IEnumerable<TSource>, IEnumerable<TSource>)
December 03, 2013
Produces the set union of two sequences by using the default equality comparer.
Assembly: System.Core (in System.Core.dll)
public static IEnumerable<TSource> Union<TSource>( this IEnumerable<TSource> first, IEnumerable<TSource> second )
The type of the elements of the input sequences.
- Type: System.Collections.Generic.IEnumerable<>
An IEnumerable<T> whose distinct elements form the first set for the union.
Return ValueType: System.Collections.Generic.IEnumerable<>
An IEnumerable<T> that contains the elements from both input sequences, excluding duplicates.
Usage NoteIn Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<>. When you use instance method syntax to call this method, omit the first parameter.
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.
This method excludes duplicates from the return set. This is different behavior to the Concat<TSource> method, which returns all the elements in the input sequences including duplicates.
The default equality comparer, Default, is used to compare values of the types that implement the IEqualityComparer<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.
When the object returned by this method is enumerated, Union enumerates first and second in that order and yields each element that has not already been yielded.
The following code example demonstrates how to use to obtain the union of two sequences of integers.
If you want to compare sequences of objects of a custom data type, you have to implement the IEqualityComparer<T> generic interface in the class.