Lean  $LEAN_TAG$
Static Public Member Functions | List of all members
QuantConnect.BinaryComparisonExtensions Class Reference

Provides convenience extension methods for applying a BinaryComparison to collections. More...

Static Public Member Functions

static TCollection Filter< T, TCollection > (this BinaryComparison comparison, TCollection values, T reference)
 Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42. More...
 
static SortedDictionary< TKey, TValue > Filter< TKey, TValue > (this BinaryComparison comparison, SortedDictionary< TKey, TValue > values, TKey reference)
 Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42. More...
 
static ImmutableSortedDictionary< TKey, TValue > Filter< TKey, TValue > (this BinaryComparison comparison, ImmutableSortedDictionary< TKey, TValue > values, TKey reference)
 Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42. More...
 
static Tuple< ImmutableSortedDictionary< TKey, TValue >, ImmutableSortedDictionary< TKey, TValue > > SplitBy< TKey, TValue > (this BinaryComparison comparison, ImmutableSortedDictionary< TKey, TValue > values, TKey reference)
 Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42. More...
 

Detailed Description

Provides convenience extension methods for applying a BinaryComparison to collections.

Definition at line 26 of file BinaryComparisonExtensions.cs.

Member Function Documentation

◆ Filter< T, TCollection >()

static TCollection QuantConnect.BinaryComparisonExtensions.Filter< T, TCollection > ( this BinaryComparison  comparison,
TCollection  values,
T  reference 
)
static

Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42.

Type Constraints
TCollection :ICollection<T> 
TCollection :new() 

Definition at line 34 of file BinaryComparisonExtensions.cs.

◆ Filter< TKey, TValue >() [1/2]

static SortedDictionary<TKey, TValue> QuantConnect.BinaryComparisonExtensions.Filter< TKey, TValue > ( this BinaryComparison  comparison,
SortedDictionary< TKey, TValue >  values,
TKey  reference 
)
static

Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42.

Definition at line 60 of file BinaryComparisonExtensions.cs.

◆ Filter< TKey, TValue >() [2/2]

static ImmutableSortedDictionary<TKey, TValue> QuantConnect.BinaryComparisonExtensions.Filter< TKey, TValue > ( this BinaryComparison  comparison,
ImmutableSortedDictionary< TKey, TValue >  values,
TKey  reference 
)
static

Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42.

Definition at line 114 of file BinaryComparisonExtensions.cs.

◆ SplitBy< TKey, TValue >()

static Tuple<ImmutableSortedDictionary<TKey, TValue>, ImmutableSortedDictionary<TKey, TValue> > QuantConnect.BinaryComparisonExtensions.SplitBy< TKey, TValue > ( this BinaryComparison  comparison,
ImmutableSortedDictionary< TKey, TValue >  values,
TKey  reference 
)
static

Filters the provided values according to this BinaryComparison and the specified reference value. The reference value is used as the RIGHT side of the binary comparison. Consider the binary comparison is LessThan and we call Filter(values, 42). We're looking for keys that are less than 42.

Definition at line 165 of file BinaryComparisonExtensions.cs.

The documentation for this class was generated from the following file: