azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: clarify docs for 'generateSequence'.

Browse Source
This commit is contained in:
Ilya Gorbunov
2016-08-03 19:01:04 +03:00
parent fed24c2be6
commit ae985e24ca
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/stdlib/src/kotlin/collections/Sequences.kt
+14 -7
View File
@@ -551,7 +551,7 @@ private class ConstrainedOnceSequence<T>(sequence: Sequence<T>) : Sequence<T> {
/**
* Returns a sequence which invokes the function to calculate the next value on each iteration until the function returns `null`.
*
* Returned sequence is constrained to be iterated only once.
* The returned sequence is constrained to be iterated only once.
*
* @see constrainOnce
*/
@@ -560,10 +560,13 @@ public fun <T : Any> generateSequence(nextFunction: () -> T?): Sequence<T> {
}
/**
* Returns a sequence which invokes the function to calculate the next value based on the previous one on each iteration
* until the function returns `null`. The sequence starts with the specified [seed].
* Returns a sequence defined by the starting value [seed] and the function [nextFunction],
* which is invoked to calculate the next value based on the previous one on each iteration.
*
* The sequence can be iterated multiple times, each time starting with the [seed].
* The sequence produces values until it encounters first `null` value.
* If [seed] is `null`, an empty sequence is produced.
*
* The sequence can be iterated multiple times, each time starting with [seed].
*/
@kotlin.internal.LowPriorityInOverloadResolution
public fun <T : Any> generateSequence(seed: T?, nextFunction: (T) -> T?): Sequence<T> =
@@ -573,9 +576,13 @@ public fun <T : Any> generateSequence(seed: T?, nextFunction: (T) -> T?): Sequen
GeneratorSequence({ seed }, nextFunction)
/**
* Returns a sequence which invokes the function [seedFunction] to get the first item and then
* [nextFunction] to calculate the next value based on the previous one on each iteration
* until the function returns `null`. The sequence starts with the value returned by [seedFunction].
* Returns a sequence defined by the function [seedFunction], which is invoked to produce the starting value,
* and the [nextFunction], which is invoked to calculate the next value based on the previous one on each iteration.
*
* The sequence produces values until it encounters first `null` value.
* If [seedFunction] returns `null`, an empty sequence is produced.
*
* The sequence can be iterated multiple times.
*/
public fun <T: Any> generateSequence(seedFunction: () -> T?, nextFunction: (T) -> T?): Sequence<T> =
GeneratorSequence(seedFunction, nextFunction)