| AlgorithmsSetDifferenceT Method (IEnumerableT, IEnumerableT) |
Computes the set-theoretic difference of two collections. The difference of two sets
is all items that appear in the first set, but not in the second. If an item appears X times in the first set,
and Y times in the second set, the difference contains the item X - Y times (0 times if X < Y).
The source collections are not changed.
A new collection is created with the difference of the collections; the order of the
items in this collection is undefined.
Namespace: X3Platform.Collections
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)
Syntaxpublic static IEnumerable<T> SetDifference<T>( IEnumerable<T> collection1, IEnumerable<T> collection2 )
Parameters
- collection1
- Type: System.Collections.GenericIEnumerableT
The first collection to difference. - collection2
- Type: System.Collections.GenericIEnumerableT
The second collection to difference.
Type Parameters
- T
[Missing <typeparam name="T"/> documentation for "M:X3Platform.Collections.Algorithms.SetDifference``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEnumerable{``0})"]
Return Value
Type: IEnumerableTThe difference of collection1 and collection2, considered as sets.
Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | collection1 or collection2 is null. |
RemarksWhen equal items appear in both collections, the returned collection will include an arbitrary choice of one of the two equal items.
The default sense of equality for T is used, as defined by T's implementation of IComparable<T>.Equals or object.Equals.
If both collections are Set, Bag, OrderedSet, or OrderedBag collections, it is more efficient to use the Difference or DifferenceWith methods on that class.
See Also