Click or drag to resize
OrderedSetTRange Method
Returns a View collection that can be used for enumerating a range of the items in the set.. Only items that are greater than from and less than to are included. The items are enumerated in sorted order. Items equal to the end points of the range can be included or excluded depending on the fromInclusive and toInclusive parameters.

Namespace: X3Platform.Collections
Assembly: X3Platform.Support (in X3Platform.Support.dll) Version: 1.0.0.0 (2.0.0.0)
Syntax
Copy
public OrderedSetTView Range(
	T from,
	bool fromInclusive,
	T to,
	bool toInclusive
)

Parameters

from
Type: T
The lower bound of the range.
fromInclusive
Type: SystemBoolean
If true, the lower bound is inclusive--items equal to the lower bound will be included in the range. If false, the lower bound is exclusive--items equal to the lower bound will not be included in the range.
to
Type: T
The upper bound of the range.
toInclusive
Type: SystemBoolean
If true, the upper bound is inclusive--items equal to the upper bound will be included in the range. If false, the upper bound is exclusive--items equal to the upper bound will not be included in the range.

Return Value

Type: OrderedSetTView
An OrderedSet.View of items in the given range.
Remarks

If from is greater than to, the returned collection is empty.

Typically, this method is used in conjunction with a foreach statement. For example:

Copy
foreach(T item in set.Range(from, true, to, false)) {
   // process item
}

If an item is added to or deleted from the set while the View is being enumerated, then the enumeration will end with an InvalidOperationException.

Calling Range does not copy the data in the tree, and the operation takes constant time.

See Also