module types_linq.ordered_enumerable

class OrderedEnumerable[TSource_co, TKey]

from types_linq.ordered_enumerable import OrderedEnumerable

Represents a sorted Enumerable sequence that is sorted by some key.

Users should not construct instances of this class directly. Use Enumerable.order_by() instead.

Bases

  • Enumerable[TSource_co]

  • Generic[TSource_co, TKey]

Members

instancemethod create_ordered_enumerable[TKey2](key_selector, comparer, descending)

Parameters

  • key_selector (Callable[[TSource_co], TKey2])

  • comparer (Optional[Callable[[TKey2, TKey2], int]])

  • descending (bool)

Returns

  • OrderedEnumerable[TSource_co, TKey2]

Performs a subsequent ordering on the elements of the sequence according to a key.

Comparer takes two values and return positive ints when lhs > rhs, negative ints if lhs < rhs, and 0 if they are equal.

Revisions:

  • v0.1.2: Fixed incorrect parameter type of comparer.

instancemethod then_by[TSupportsLessThan](key_selector)

Parameters

  • key_selector (Callable[[TSource_co], TSupportsLessThan])

Returns

  • OrderedEnumerable[TSource_co, TSupportsLessThan]

Performs a subsequent ordering of the elements in ascending order according to key.

Example
>>> class Pet(NamedTuple):
...     name: str
...     age: int

>>> pets = [Pet('Barley', 8), Pet('Boots', 4), Pet('Roman', 5), Pet('Daisy', 4)]
>>> Enumerable(pets).order_by(lambda p: p.age) \
...     .then_by(lambda p: p.name)             \
...     .select(lambda p: p.name)              \
...     .to_list()
['Boots', 'Daisy', 'Roman', 'Barley']

instancemethod then_by[TKey2](key_selector, __comparer)

Parameters

  • key_selector (Callable[[TSource_co], TKey2])

  • __comparer (Callable[[TKey2, TKey2], int])

Returns

  • OrderedEnumerable[TSource_co, TKey2]

Performs a subsequent ordering of the elements in ascending order by using a specified comparer.

Such comparer takes two values and return positive ints when lhs > rhs, negative ints if lhs < rhs, and 0 if they are equal.

instancemethod then_by_descending[TSupportsLessThan](key_selector)

Parameters

  • key_selector (Callable[[TSource_co], TSupportsLessThan])

Returns

  • OrderedEnumerable[TSource_co, TSupportsLessThan]

Performs a subsequent ordering of the elements in descending order according to key.

instancemethod then_by_descending[TKey2](key_selector, __comparer)

Parameters

  • key_selector (Callable[[TSource_co], TKey2])

  • __comparer (Callable[[TKey2, TKey2], int])

Returns

  • OrderedEnumerable[TSource_co, TKey2]

Performs a subsequent ordering of the elements in descending order by using a specified comparer.

Such comparer takes two values and return positive ints when lhs > rhs, negative ints if lhs < rhs, and 0 if they are equal.