sortedsequence/io.timvanoijen.github.kotlin.sortedsequence/SortedSequence

SortedSequence

class SortedSequence<TKey : Comparable<TKey>, out TValue> : SortedKeyValueIteratorProvider<TKey, TValue> , Sequence<TValue>

Represents a sequence of elements that are sorted by key. This class provides operations for working with sorted sequences like mapping values, grouping and joining.

Example:

val sequence = sequenceOf("az", "by", "cx").assertSortedBy { it.first() }

Parameters

TKey

The type of keys in the sequence, must be comparable

TValue

The type of values in the sequence

Types

Factory

object Factory

Properties

sortOrder

open override val sortOrder: SortOrder

The sort order (ascending/descending) of the sequence

Functions

assertSorted

fun <TKey : Comparable<TKey>, TValue> Sequence<Pair<TKey, TValue>>.assertSorted(sortOrder: SortOrder = ASCENDING): SortedKeyValueSequence<TKey, TValue>

Creates a SortedKeyValueSequence from this sequence, asserting that elements are sorted by their key.

fun <T : Comparable<T>> Sequence<T>.assertSorted(sortOrder: SortOrder = ASCENDING): SortedSequence<T, T>

Creates a SortedSequence from this sequence, asserting that elements are sorted according to their natural order.

assertSortedBy

fun <TKey : Comparable<TKey>, TValue> Sequence<TValue>.assertSortedBy(sortOrder: SortOrder = ASCENDING, keySelector: (TValue) -> TKey): SortedSequence<TKey, TValue>

Creates a SortedSequence from this sequence, asserting that elements are sorted by the given key selector.

asSortedKeyValues

fun asSortedKeyValues(): SortedKeyValueSequence<TKey, TValue>

Converts this SortedSequence to a SortedKeyValueSequence.

distinctByKey

fun distinctByKey(): SortedSequence<TKey, TValue>

Returns a new sequence containing only the first occurrence of each key.

filter

fun filter(filterFn: (TValue) -> Boolean): SortedSequence<TKey, TValue>

Filters the sequence to only include elements whose values match the given predicate. This is an alias for filterByValue.

filterByKey

fun filterByKey(filterFn: (TKey) -> Boolean): SortedSequence<TKey, TValue>

Filters the sequence to only include elements whose keys match the given predicate.

filterByValue

fun filterByValue(filterFn: (TValue) -> Boolean): SortedSequence<TKey, TValue>

Filters the sequence to only include elements whose values match the given predicate.

fullOuterJoinByKey

fun <TValue2> fullOuterJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue?, TValue2?>>

Performs a full outer join with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> fullOuterJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue?, TValue2?) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs a full outer join with another sorted sequence.

fullOuterZipByKey

fun <TValue2> fullOuterZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue?, TValue2?>>

Performs a full outer zip with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> fullOuterZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue?, TValue2?) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs a full outer zip with another sorted sequence.

groupByKey

fun groupByKey(): SortedSequence<TKey, List<TValue>>

Groups values by their sorting key, maintaining sort order.

innerJoinByKey

fun <TValue2> innerJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue, TValue2>>

Performs an inner join with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> innerJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue, TValue2) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs an inner join with another sorted sequence.

innerZipByKey

fun <TValue2> innerZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue, TValue2>>

Performs an inner zip with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> innerZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue, TValue2) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs an inner zip with another sorted sequence.

interleaveByKey

fun <TKey : Comparable<TKey>, TValue> SortedSequence<TKey, TValue>.interleaveByKey(other: SortedKeyValueIteratorProvider<TKey, TValue>): SortedSequence<TKey, TValue>

Interleaves elements from this sequence with those from another sequence while maintaining sort order.

iterator

open operator override fun iterator(): Iterator<TValue>

joinByKey

fun <TValue2> joinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, joinType: JoinType = FULL_OUTER_JOIN): SortedSequence<TKey, Pair<TValue?, TValue2?>>

Performs a join between two sorted sequences based on matching keys using default pairing of values.

fun <TValue2, TValueOut> joinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, joinType: JoinType = FULL_OUTER_JOIN, mergeFn: (TKey, TValue?, TValue2?) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs a join between two sorted sequences based on matching keys.

keyValueIterator

open override fun keyValueIterator(): Iterator<Pair<TKey, TValue>>

Returns an iterator over the key-value pairs in this sequence while verifying the sort order.

leftOuterJoinByKey

fun <TValue2> leftOuterJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue, TValue2?>>

Performs a left outer join with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> leftOuterJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue, TValue2?) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs a left outer join with another sorted sequence.

leftOuterZipByKey

fun <TValue2> leftOuterZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue, TValue2?>>

Performs a left outer zip with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> leftOuterZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue, TValue2?) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs a left outer zip with another sorted sequence.

rightOuterJoinByKey

fun <TValue2> rightOuterJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue?, TValue2?>>

Performs a right outer join with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> rightOuterJoinByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue?, TValue2) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs a right outer join with another sorted sequence.

rightOuterZipByKey

fun <TValue2> rightOuterZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>): SortedSequence<TKey, Pair<TValue?, TValue2?>>

Performs a right outer zip with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> rightOuterZipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, mergeFn: (TKey, TValue?, TValue2) -> TValueOut): SortedSequence<TKey, TValueOut>

Performs a right outer zip with another sorted sequence.

zipByKey

fun <TValue2> zipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, joinType: JoinType = FULL_OUTER_JOIN): SortedSequence<TKey, Pair<TValue?, TValue2?>>

Zips the sequence with another sorted sequence using default pairing of values.

fun <TValue2, TValueOut> zipByKey(other: SortedKeyValueIteratorProvider<TKey, TValue2>, joinType: JoinType = FULL_OUTER_JOIN, mergeFn: (TKey, TValue?, TValue2?) -> TValueOut): SortedSequence<TKey, TValueOut>

Zips the sequence with another sorted sequence based on matching keys.