kone.collections/dev.lounres.kone.collections.iterables

Package-level declarations

Types

KoneExtendableIterable

@Serializable(with = DefaultKoneExtendableIterableSerializer::class)

interface KoneExtendableIterable<Element> : KoneIterable<Element>

Represents KoneIterable that can be iterated by KoneExtendableIterator.

KoneExtendableIterator

interface KoneExtendableIterator<Element> : KoneIterator<Element>

Represents a KoneIterator that can add element right after its pointer.

KoneExtendableLinearIterable

@Serializable(with = DefaultKoneExtendableLinearIterableSerializer::class)

interface KoneExtendableLinearIterable<Element> : KoneLinearIterable<Element> , KoneReversibleExtendableIterable<Element>

Represents KoneIterable that can be iterated by KoneExtendableLinearIterator.

KoneExtendableLinearIterator

interface KoneExtendableLinearIterator<Element> : KoneLinearIterator<Element> , KoneReversibleExtendableIterator<Element>

Represents KoneLinearIterator and KoneReversibleExtendableIterator at the same time.

KoneIterable

@Serializable(with = DefaultKoneIterableSerializer::class)

interface KoneIterable<out Element>

Represents a finite collection of elements with described size and iteration over it.

KoneIterator

interface KoneIterator<out Element>

Represents an iterator over some elements (maybe even infinite number of elements) in some (maybe temporary) order.

KoneLinearIterable

@Serializable(with = DefaultKoneLinearIterableSerializer::class)

interface KoneLinearIterable<out Element> : KoneReversibleIterable<Element>

Represents KoneIterable that can be iterated by KoneLinearIterator.

KoneLinearIterator

interface KoneLinearIterator<out Element> : KoneReversibleIterator<Element>

Represents a KoneReversibleIterator over some set of elements that has permanent order on the elements and permanent indices of the elements.

KoneMutableIterable

@Serializable(with = DefaultKoneMutableIterableSerializer::class)

interface KoneMutableIterable<Element> : KoneSettableIterable<Element> , KoneExtendableIterable<Element> , KoneRemovableIterable<Element>

Represents KoneIterable that can be iterated by KoneMutableIterator.

KoneMutableIterator

interface KoneMutableIterator<Element> : KoneSettableIterator<Element> , KoneExtendableIterator<Element> , KoneRemovableIterator<Element>

Represents a KoneIterator that can add, set, and remove the next element.

KoneMutableLinearIterable

@Serializable(with = DefaultKoneMutableLinearIterableSerializer::class)

interface KoneMutableLinearIterable<Element> : KoneSettableLinearIterable<Element> , KoneExtendableLinearIterable<Element> , KoneRemovableLinearIterable<Element> , KoneReversibleMutableIterable<Element>

Represents KoneIterable that can be iterated by KoneMutableLinearIterator.

KoneMutableLinearIterator

interface KoneMutableLinearIterator<Element> : KoneReversibleMutableIterator<Element> , KoneSettableLinearIterator<Element> , KoneExtendableLinearIterator<Element> , KoneRemovableLinearIterator<Element>

Represents KoneLinearIterator and KoneReversibleMutableIterator at the same time.

KoneRemovableIterable

@Serializable(with = DefaultKoneRemovableIterableSerializer::class)

interface KoneRemovableIterable<out Element> : KoneIterable<Element>

Represents KoneIterable that can be iterated by KoneRemovableIterator.

KoneRemovableIterator

interface KoneRemovableIterator<out Element> : KoneIterator<Element>

Represents a KoneIterator that can remove the next element if it's present.

KoneRemovableLinearIterable

@Serializable(with = DefaultKoneRemovableLinearIterableSerializer::class)

interface KoneRemovableLinearIterable<out Element> : KoneLinearIterable<Element> , KoneReversibleRemovableIterable<Element>

Represents KoneIterable that can be iterated by KoneRemovableLinearIterator.

KoneRemovableLinearIterator

interface KoneRemovableLinearIterator<out Element> : KoneLinearIterator<Element> , KoneReversibleRemovableIterator<Element>

Represents KoneLinearIterator and KoneReversibleRemovableIterator at the same time.

KoneReversibleExtendableIterable

@Serializable(with = DefaultKoneReversibleExtendableIterableSerializer::class)

interface KoneReversibleExtendableIterable<Element> : KoneReversibleIterable<Element> , KoneExtendableIterable<Element>

Represents KoneIterable that can be iterated by KoneReversibleExtendableIterator.

KoneReversibleExtendableIterator

interface KoneReversibleExtendableIterator<Element> : KoneReversibleIterator<Element> , KoneExtendableIterator<Element>

Represents a KoneReversibleIterator that can add element right after and right before its pointer.

KoneReversibleIterable

@Serializable(with = DefaultKoneReversibleIterableSerializer::class)

interface KoneReversibleIterable<out Element> : KoneIterable<Element>

Represents KoneIterable that can be iterated by KoneReversibleIterator.

KoneReversibleIterator

interface KoneReversibleIterator<out Element> : KoneIterator<Element>

Represents an KoneIterator that can iterate over the elements in both directions, forward and backward.

KoneReversibleMutableIterable

@Serializable(with = DefaultKoneReversibleMutableIterableSerializer::class)

interface KoneReversibleMutableIterable<Element> : KoneMutableIterable<Element> , KoneReversibleSettableIterable<Element> , KoneReversibleExtendableIterable<Element> , KoneReversibleRemovableIterable<Element>

Represents KoneIterable that can be iterated by KoneReversibleMutableIterator.

KoneReversibleMutableIterator

interface KoneReversibleMutableIterator<Element> : KoneMutableIterator<Element> , KoneReversibleSettableIterator<Element> , KoneReversibleExtendableIterator<Element> , KoneReversibleRemovableIterator<Element>

Represents a KoneReversibleIterator that can add, set, and remove both the next and the previous elements.

KoneReversibleRemovableIterable

@Serializable(with = DefaultKoneReversibleRemovableIterableSerializer::class)

interface KoneReversibleRemovableIterable<out Element> : KoneReversibleIterable<Element> , KoneRemovableIterable<Element>

Represents KoneIterable that can be iterated by KoneReversibleRemovableIterator.

KoneReversibleRemovableIterator

interface KoneReversibleRemovableIterator<out Element> : KoneReversibleIterator<Element> , KoneRemovableIterator<Element>

Represents a KoneReversibleIterator that can remove the next and the previous elements if they're present.

KoneReversibleSettableIterable

@Serializable(with = DefaultKoneReversibleSettableIterableSerializer::class)

interface KoneReversibleSettableIterable<Element> : KoneReversibleIterable<Element> , KoneSettableIterable<Element>

Represents KoneIterable that can be iterated by KoneReversibleSettableIterator.

KoneReversibleSettableIterator

interface KoneReversibleSettableIterator<Element> : KoneReversibleIterator<Element> , KoneSettableIterator<Element>

Represents a KoneReversibleIterator that can change value of the next element and the previous element if they're present.

KoneSettableIterable

@Serializable(with = DefaultKoneSettableIterableSerializer::class)

interface KoneSettableIterable<Element> : KoneIterable<Element>

Represents KoneIterable that can be iterated by KoneSettableIterator.

KoneSettableIterator

interface KoneSettableIterator<Element> : KoneIterator<Element>

Represents a KoneIterator that can change value of the next element if it's present.

KoneSettableLinearIterable

@Serializable(with = DefaultKoneSettableLinearMutableIterableSerializer::class)

interface KoneSettableLinearIterable<Element> : KoneLinearIterable<Element> , KoneReversibleSettableIterable<Element>

Represents KoneIterable that can be iterated by KoneSettableLinearIterator.

KoneSettableLinearIterator

interface KoneSettableLinearIterator<Element> : KoneLinearIterator<Element> , KoneReversibleSettableIterator<Element>

Represents KoneLinearIterator and KoneReversibleSettableIterator at the same time.

Functions

contains

operator fun <Element> KoneIterable<Element>.contains(element: Element): Boolean

containsAllFrom

fun <Element> KoneIterable<Element>.containsAllFrom(elements: KoneIterable<Element>): Boolean

getAndMoveNext

fun <Element> KoneIterator<Element>.getAndMoveNext(): Element

Gets the next element, moves forward, and returns the got element.

getAndMovePrevious

fun <Element> KoneReversibleIterator<Element>.getAndMovePrevious(): Element

Gets the previous element, moves backward, and returns the got element.

isEmpty

fun <Element> KoneIterable<Element>.isEmpty(): Boolean

Checks if the iterable is empty.

isNotEmpty

fun <Element> KoneIterable<Element>.isNotEmpty(): Boolean

Checks if the iterable is not empty.

inline operator fun <Element> KoneIterator<Element>.next(): Element

Gets the next element moves forward and returns the got element. It is an operator function to use in for cycles.