IsSubsetOf Generic Method

Wintellect PowerCollections

Collapse imageExpand ImageCollapseAll imageExpandAll imageDropDown imageDropDownHover imageCopy imageCopyHover image
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Determines if one collection is a subset of another, considered as sets. The first set is a subset of the second set if every item in the first set also occurs in the second set. If an item appears X times in the first set, it must appear at least X times in the second set.

Namespace: Wintellect.PowerCollections
Assembly:  PowerCollections (in PowerCollections.dll)

Syntax

C#
public static bool IsSubsetOf<T>(
	IEnumerable<T> collection1,
	IEnumerable<T> collection2,
	IEqualityComparer<T> equalityComparer
)
Visual Basic (Declaration)
Public Shared Function IsSubsetOf(Of T) ( _
	collection1 As IEnumerable(Of T), _
	collection2 As IEnumerable(Of T), _
	equalityComparer As IEqualityComparer(Of T) _
) As Boolean
Visual C++
public:
generic<typename T>
static bool IsSubsetOf (
	IEnumerable<T>^ collection1, 
	IEnumerable<T>^ collection2, 
	IEqualityComparer<T>^ equalityComparer
)

Parameters

collection1
IEnumerable<(Of <T>)>
The first collection.
collection2
IEnumerable<(Of <T>)>
The second collection.
equalityComparer
IEqualityComparer<(Of <T>)>
The IEqualityComparer<T> used to compare items for equality.

Return Value

True if collection1 is a subset of collection2, considered as sets.

Type Parameters

T

Remarks

If both collections are Set, Bag, OrderedSet, or OrderedBag collections, it is more efficient to use the IsSubsetOf method on that class.

Exceptions

ExceptionCondition
System..::ArgumentNullExceptioncollection1 or collection2 is null.

See Also