LongProgression
Properties
first
The first element in the progression.
val first: Longlast
The last element in the progression.
val last: Longstep
The step of the progression.
val step: LongFunctions
equals
Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:
open fun equals(other: Any?): BooleanhashCode
Returns a hash code value for the object. The general contract of hashCode is:
open fun hashCode(): IntisEmpty
Checks if the progression is empty.
open fun isEmpty(): Booleaniterator
open fun iterator(): LongIteratortoString
Returns a string representation of the object.
open fun toString(): StringCompanion Object Functions
fromClosedRange
Creates LongProgression within the specified bounds of a closed range.
fun fromClosedRange(
rangeStart: Long,
rangeEnd: Long,
step: Long
): LongProgressionExtension Functions
associateBy
Returns a Map containing the elements from the given collection indexed by the key returned from keySelector function applied to each element.
Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given collection.
associateByTo
Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each element of the given collection and value is the element itself.
fun <T, K, M : MutableMap<in K, in T>> Iterable<T>.associateByTo(
destination: M,
keySelector: (T) -> K
): MPopulates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to elements of the given collection.
fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateByTo(
destination: M,
keySelector: (T) -> K,
valueTransform: (T) -> V
): MassociateTo
Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each element of the given collection.
fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo(
destination: M,
transform: (T) -> Pair<K, V>
): MassociateWith
Returns a Map where keys are elements from the given collection and values are produced by the valueSelector function applied to each element.
associateWithTo
Populates and returns the destination mutable map with key-value pairs for each element of the given collection, where key is the element itself and value is provided by the valueSelector function applied to that key.
fun <K, V, M : MutableMap<in K, in V>> Iterable<K>.associateWithTo(
destination: M,
valueSelector: (K) -> V
): Maverage
Returns an average value of elements in the collection.
fun Iterable<Long>.average(): DoubleelementAt
Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this collection.
fun <T> Iterable<T>.elementAt(index: Int): TelementAtOrElse
Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this collection.
fun <T> Iterable<T>.elementAtOrElse(
index: Int,
defaultValue: (Int) -> T
): TfilterIndexedTo
Appends all elements matching the given predicate to the given destination.
fun <T, C : MutableCollection<in T>> Iterable<T>.filterIndexedTo(
destination: C,
predicate: (index: Int, T) -> Boolean
): CfilterIsInstanceTo
Appends all elements that are instances of specified type parameter R to the given destination.
fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo(
destination: C
): CfilterNotNullTo
Appends all elements that are not null to the given destination.
fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo(
destination: C
): CfilterNotTo
Appends all elements not matching the given predicate to the given destination.
fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo(
destination: C,
predicate: (T) -> Boolean
): CfilterTo
Appends all elements matching the given predicate to the given destination.
fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo(
destination: C,
predicate: (T) -> Boolean
): Cfirst
Returns the first element.
fun LongProgression.first(): LongfirstNotNullOf
Returns the first non-null value produced by transform function being applied to elements of this collection in iteration order, or throws NoSuchElementException if no non-null value was produced.
fun <T, R : Any> Iterable<T>.firstNotNullOf(
transform: (T) -> R?
): RfirstOrNull
Returns the first element, or null if the progression is empty.
fun LongProgression.firstOrNull(): Long?flatMapIndexed
Returns a single list of all elements yielded from results of transform function being invoked on each element and its index in the original collection.
flatMapIndexedTo
Appends all elements yielded from results of transform function being invoked on each element and its index in the original collection, to the given destination.
fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapIndexedTo(
destination: C,
transform: (index: Int, T) -> Iterable<R>
): Cfun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapIndexedTo(
destination: C,
transform: (index: Int, T) -> Sequence<R>
): CflatMapTo
Appends all elements yielded from results of transform function being invoked on each element of original collection, to the given destination.
fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(
destination: C,
transform: (T) -> Iterable<R>
): Cfun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo(
destination: C,
transform: (T) -> Sequence<R>
): CgroupBy
Groups elements of the original collection by the key returned by the given keySelector function applied to each element and returns a map where each group key is associated with a list of corresponding elements.
Groups values returned by the valueTransform function applied to each element of the original collection by the key returned by the given keySelector function applied to the element and returns a map where each group key is associated with a list of corresponding values.
groupByTo
Groups elements of the original collection by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements.
fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo(
destination: M,
keySelector: (T) -> K
): MGroups values returned by the valueTransform function applied to each element of the original collection by the key returned by the given keySelector function applied to the element and puts to the destination map each group key associated with a list of corresponding values.
fun <T, K, V, M : MutableMap<in K, MutableList<V>>> Iterable<T>.groupByTo(
destination: M,
keySelector: (T) -> K,
valueTransform: (T) -> V
): MgroupingBy
Creates a Grouping source from a collection to be used later with one of group-and-fold operations using the specified keySelector function to extract a key from each element.
joinTo
Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied.
fun <T, A : Appendable> Iterable<T>.joinTo(
buffer: A,
separator: CharSequence = ", ",
prefix: CharSequence = "",
postfix: CharSequence = "",
limit: Int = -1,
truncated: CharSequence = "...",
transform: ((T) -> CharSequence)? = null
): AjoinToString
Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied.
fun <T> Iterable<T>.joinToString(
separator: CharSequence = ", ",
prefix: CharSequence = "",
postfix: CharSequence = "",
limit: Int = -1,
truncated: CharSequence = "...",
transform: ((T) -> CharSequence)? = null
): Stringlast
Returns the last element.
fun LongProgression.last(): LonglastOrNull
Returns the last element, or null if the progression is empty.
fun LongProgression.lastOrNull(): Long?mapIndexedNotNullTo
Applies the given transform function to each element and its index in the original collection and appends only the non-null results to the given destination.
fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo(
destination: C,
transform: (index: Int, T) -> R?
): CmapIndexedTo
Applies the given transform function to each element and its index in the original collection and appends the results to the given destination.
fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo(
destination: C,
transform: (index: Int, T) -> R
): CmapNotNullTo
Applies the given transform function to each element in the original collection and appends only the non-null results to the given destination.
fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo(
destination: C,
transform: (T) -> R?
): CmapTo
Applies the given transform function to each element of the original collection and appends the results to the given destination.
fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo(
destination: C,
transform: (T) -> R
): CmaxByOrNull
Returns the first element yielding the largest value of the given function or null if there are no elements.
fun <T, R : Comparable<R>> Iterable<T>.maxByOrNull(
selector: (T) -> R
): T?maxOf
Returns the largest value among all values produced by selector function applied to each element in the collection.
fun <T> Iterable<T>.maxOf(selector: (T) -> Double): Doublefun <T> Iterable<T>.maxOf(selector: (T) -> Float): Floatfun <T, R : Comparable<R>> Iterable<T>.maxOf(
selector: (T) -> R
): RmaxOfOrNull
Returns the largest value among all values produced by selector function
applied to each element in the collection or null if there are no elements.
fun <T> Iterable<T>.maxOfOrNull(
selector: (T) -> Double
): Double?fun <T> Iterable<T>.maxOfOrNull(
selector: (T) -> Float
): Float?fun <T, R : Comparable<R>> Iterable<T>.maxOfOrNull(
selector: (T) -> R
): R?maxOfWith
Returns the largest value according to the provided comparator among all values produced by selector function applied to each element in the collection.
fun <T, R> Iterable<T>.maxOfWith(
comparator: Comparator<in R>,
selector: (T) -> R
): RmaxOfWithOrNull
Returns the largest value according to the provided comparator
among all values produced by selector function applied to each element in the collection or null if there are no elements.
fun <T, R> Iterable<T>.maxOfWithOrNull(
comparator: Comparator<in R>,
selector: (T) -> R
): R?maxWith
Returns the first element having the largest value according to the provided comparator.
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): TmaxWithOrNull
Returns the first element having the largest value according to the provided comparator or null if there are no elements.
fun <T> Iterable<T>.maxWithOrNull(
comparator: Comparator<in T>
): T?minByOrNull
Returns the first element yielding the smallest value of the given function or null if there are no elements.
fun <T, R : Comparable<R>> Iterable<T>.minByOrNull(
selector: (T) -> R
): T?minOf
Returns the smallest value among all values produced by selector function applied to each element in the collection.
fun <T> Iterable<T>.minOf(selector: (T) -> Double): Doublefun <T> Iterable<T>.minOf(selector: (T) -> Float): Floatfun <T, R : Comparable<R>> Iterable<T>.minOf(
selector: (T) -> R
): RminOfOrNull
Returns the smallest value among all values produced by selector function
applied to each element in the collection or null if there are no elements.
fun <T> Iterable<T>.minOfOrNull(
selector: (T) -> Double
): Double?fun <T> Iterable<T>.minOfOrNull(
selector: (T) -> Float
): Float?fun <T, R : Comparable<R>> Iterable<T>.minOfOrNull(
selector: (T) -> R
): R?minOfWith
Returns the smallest value according to the provided comparator among all values produced by selector function applied to each element in the collection.
fun <T, R> Iterable<T>.minOfWith(
comparator: Comparator<in R>,
selector: (T) -> R
): RminOfWithOrNull
Returns the smallest value according to the provided comparator
among all values produced by selector function applied to each element in the collection or null if there are no elements.
fun <T, R> Iterable<T>.minOfWithOrNull(
comparator: Comparator<in R>,
selector: (T) -> R
): R?minus
Returns a list containing all elements of the original collection without the first occurrence of the given element.
Returns a list containing all elements of the original collection except the elements contained in the given elements array.
Returns a list containing all elements of the original collection except the elements contained in the given elements collection.
minWith
Returns the first element having the smallest value according to the provided comparator.
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): TminWithOrNull
Returns the first element having the smallest value according to the provided comparator or null if there are no elements.
fun <T> Iterable<T>.minWithOrNull(
comparator: Comparator<in T>
): T?plus
Returns a list containing all elements of the original collection and then the given element.
Returns a list containing all elements of the original collection and then all elements of the given elements array.
Returns a list containing all elements of the original collection and then all elements of the given elements collection.
requireNoNulls
Returns an original collection containing all the non-null elements, throwing an IllegalArgumentException if there are any null elements.
reversed
Returns a progression that goes over the same range in the opposite direction with the same step.
fun LongProgression.reversed(): LongProgressionrunningFoldIndexed
runningReduceIndexed
Returns a list containing successive accumulation values generated by applying operation from left to right to each element, its index in the original collection and current accumulator value that starts with the first element of this collection.
scanIndexed
single
Returns the single element, or throws an exception if the collection is empty or has more than one element.
fun <T> Iterable<T>.single(): TsingleOrNull
Returns single element, or null if the collection is empty or has more than one element.
fun <T> Iterable<T>.singleOrNull(): T?sortedBy
Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function.
fun <T, R : Comparable<R>> Iterable<T>.sortedBy(
selector: (T) -> R?
): List<T>sortedByDescending
Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function.
fun <T, R : Comparable<R>> Iterable<T>.sortedByDescending(
selector: (T) -> R?
): List<T>sortedWith
Returns a list of all elements sorted according to the specified comparator.
fun <T> Iterable<T>.sortedWith(
comparator: Comparator<in T>
): List<T>step
Returns a progression that goes over the same range with the given step.
infix fun LongProgression.step(step: Long): LongProgressionsumOf
toCollection
Appends all elements to the given destination collection.
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection(
destination: C
): CtoMutableList
Returns a new MutableList filled with all elements of this collection.
fun <T> Iterable<T>.toMutableList(): MutableList<T>toMutableSet
Returns a new MutableSet containing all distinct elements from the given collection.
fun <T> Iterable<T>.toMutableSet(): MutableSet<T>windowed
Returns a list of snapshots of the window of the given size sliding along this collection with the given step, where each snapshot is a list.
withIndex
Returns a lazy Iterable that wraps each element of the original collection into an IndexedValue containing the index of that element and the element itself.
fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>>zip
Returns a list of pairs built from the elements of this collection and the other array with the same index.
The returned list has length of the shortest collection.
Returns a list of values built from the elements of this collection and the other array with the same index
using the provided transform function applied to each pair of elements.
The returned list has length of the shortest collection.
Returns a list of pairs built from the elements of this collection and other collection with the same index.
The returned list has length of the shortest collection.
zipWithNext
Returns a list of pairs of each two adjacent elements in this collection.
Inheritors
LongRange
A range of values of type Long.
class LongRange :
LongProgression,
ClosedRange<Long>,
OpenEndRange<Long>