Improve docs wording of zip function

This commit is contained in:
Ilya Gorbunov
2018-04-20 02:44:48 +03:00
parent 0eae27e03f
commit 501d969a38
5 changed files with 175 additions and 72 deletions
+130 -52
View File
@@ -12206,7 +12206,8 @@ public inline fun CharArray.partition(predicate: (Char) -> Boolean): Pair<List<C
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12215,7 +12216,8 @@ public infix fun <T, R> Array<out T>.zip(other: Array<out R>): List<Pair<T, R>>
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12224,7 +12226,8 @@ public infix fun <R> ByteArray.zip(other: Array<out R>): List<Pair<Byte, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12233,7 +12236,8 @@ public infix fun <R> ShortArray.zip(other: Array<out R>): List<Pair<Short, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12242,7 +12246,8 @@ public infix fun <R> IntArray.zip(other: Array<out R>): List<Pair<Int, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12251,7 +12256,8 @@ public infix fun <R> LongArray.zip(other: Array<out R>): List<Pair<Long, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12260,7 +12266,8 @@ public infix fun <R> FloatArray.zip(other: Array<out R>): List<Pair<Float, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12269,7 +12276,8 @@ public infix fun <R> DoubleArray.zip(other: Array<out R>): List<Pair<Double, R>>
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12278,7 +12286,8 @@ public infix fun <R> BooleanArray.zip(other: Array<out R>): List<Pair<Boolean, R
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12287,7 +12296,9 @@ public infix fun <R> CharArray.zip(other: Array<out R>): List<Pair<Char, R>> {
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12301,7 +12312,9 @@ public inline fun <T, R, V> Array<out T>.zip(other: Array<out R>, transform: (a:
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12315,7 +12328,9 @@ public inline fun <R, V> ByteArray.zip(other: Array<out R>, transform: (a: Byte,
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12329,7 +12344,9 @@ public inline fun <R, V> ShortArray.zip(other: Array<out R>, transform: (a: Shor
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12343,7 +12360,9 @@ public inline fun <R, V> IntArray.zip(other: Array<out R>, transform: (a: Int, b
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12357,7 +12376,9 @@ public inline fun <R, V> LongArray.zip(other: Array<out R>, transform: (a: Long,
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12371,7 +12392,9 @@ public inline fun <R, V> FloatArray.zip(other: Array<out R>, transform: (a: Floa
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12385,7 +12408,9 @@ public inline fun <R, V> DoubleArray.zip(other: Array<out R>, transform: (a: Dou
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12399,7 +12424,9 @@ public inline fun <R, V> BooleanArray.zip(other: Array<out R>, transform: (a: Bo
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12413,7 +12440,8 @@ public inline fun <R, V> CharArray.zip(other: Array<out R>, transform: (a: Char,
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12422,7 +12450,8 @@ public infix fun <T, R> Array<out T>.zip(other: Iterable<R>): List<Pair<T, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12431,7 +12460,8 @@ public infix fun <R> ByteArray.zip(other: Iterable<R>): List<Pair<Byte, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12440,7 +12470,8 @@ public infix fun <R> ShortArray.zip(other: Iterable<R>): List<Pair<Short, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12449,7 +12480,8 @@ public infix fun <R> IntArray.zip(other: Iterable<R>): List<Pair<Int, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12458,7 +12490,8 @@ public infix fun <R> LongArray.zip(other: Iterable<R>): List<Pair<Long, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12467,7 +12500,8 @@ public infix fun <R> FloatArray.zip(other: Iterable<R>): List<Pair<Float, R>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12476,7 +12510,8 @@ public infix fun <R> DoubleArray.zip(other: Iterable<R>): List<Pair<Double, R>>
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12485,7 +12520,8 @@ public infix fun <R> BooleanArray.zip(other: Iterable<R>): List<Pair<Boolean, R>
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` collection and [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12494,7 +12530,9 @@ public infix fun <R> CharArray.zip(other: Iterable<R>): List<Pair<Char, R>> {
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12510,7 +12548,9 @@ public inline fun <T, R, V> Array<out T>.zip(other: Iterable<R>, transform: (a:
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12526,7 +12566,9 @@ public inline fun <R, V> ByteArray.zip(other: Iterable<R>, transform: (a: Byte,
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12542,7 +12584,9 @@ public inline fun <R, V> ShortArray.zip(other: Iterable<R>, transform: (a: Short
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12558,7 +12602,9 @@ public inline fun <R, V> IntArray.zip(other: Iterable<R>, transform: (a: Int, b:
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12574,7 +12620,9 @@ public inline fun <R, V> LongArray.zip(other: Iterable<R>, transform: (a: Long,
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12590,7 +12638,9 @@ public inline fun <R, V> FloatArray.zip(other: Iterable<R>, transform: (a: Float
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12606,7 +12656,9 @@ public inline fun <R, V> DoubleArray.zip(other: Iterable<R>, transform: (a: Doub
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12622,7 +12674,9 @@ public inline fun <R, V> BooleanArray.zip(other: Iterable<R>, transform: (a: Boo
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12638,7 +12692,8 @@ public inline fun <R, V> CharArray.zip(other: Iterable<R>, transform: (a: Char,
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12647,7 +12702,8 @@ public infix fun ByteArray.zip(other: ByteArray): List<Pair<Byte, Byte>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12656,7 +12712,8 @@ public infix fun ShortArray.zip(other: ShortArray): List<Pair<Short, Short>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12665,7 +12722,8 @@ public infix fun IntArray.zip(other: IntArray): List<Pair<Int, Int>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12674,7 +12732,8 @@ public infix fun LongArray.zip(other: LongArray): List<Pair<Long, Long>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12683,7 +12742,8 @@ public infix fun FloatArray.zip(other: FloatArray): List<Pair<Float, Float>> {
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12692,7 +12752,8 @@ public infix fun DoubleArray.zip(other: DoubleArray): List<Pair<Double, Double>>
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12701,7 +12762,8 @@ public infix fun BooleanArray.zip(other: BooleanArray): List<Pair<Boolean, Boole
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* Returns a list of pairs built from the elements of `this` array and the [other] array with the same index.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -12710,7 +12772,9 @@ public infix fun CharArray.zip(other: CharArray): List<Pair<Char, Char>> {
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12724,7 +12788,9 @@ public inline fun <V> ByteArray.zip(other: ByteArray, transform: (a: Byte, b: By
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12738,7 +12804,9 @@ public inline fun <V> ShortArray.zip(other: ShortArray, transform: (a: Short, b:
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12752,7 +12820,9 @@ public inline fun <V> IntArray.zip(other: IntArray, transform: (a: Int, b: Int)
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12766,7 +12836,9 @@ public inline fun <V> LongArray.zip(other: LongArray, transform: (a: Long, b: Lo
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12780,7 +12852,9 @@ public inline fun <V> FloatArray.zip(other: FloatArray, transform: (a: Float, b:
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12794,7 +12868,9 @@ public inline fun <V> DoubleArray.zip(other: DoubleArray, transform: (a: Double,
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -12808,7 +12884,9 @@ public inline fun <V> BooleanArray.zip(other: BooleanArray, transform: (a: Boole
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` array 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 array.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -2085,7 +2085,8 @@ public fun <T, R> Iterable<T>.windowed(size: Int, step: Int = 1, partialWindows:
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection.
* 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.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -2094,7 +2095,9 @@ public infix fun <T, R> Iterable<T>.zip(other: Array<out R>): List<Pair<T, R>> {
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of 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.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -2110,7 +2113,8 @@ public inline fun <T, R, V> Iterable<T>.zip(other: Array<out R>, transform: (a:
}
/**
* Returns a list of pairs built from elements of both collections with same indexes. List has length of 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.
*
* @sample samples.collections.Iterables.Operations.zipIterable
*/
@@ -2119,7 +2123,9 @@ public infix fun <T, R> Iterable<T>.zip(other: Iterable<R>): List<Pair<T, R>> {
}
/**
* Returns a list of values built from elements of both collections with same indexes using provided [transform]. List has length of shortest collection.
* Returns a list of values built from the elements of `this` collection and the [other] collection with the same index
* using the provided [transform] function applied to each pair of elements.
* The returned list has length of the shortest collection.
*
* @sample samples.collections.Iterables.Operations.zipIterableWithTransform
*/
@@ -1557,8 +1557,8 @@ public fun <T, R> Sequence<T>.windowed(size: Int, step: Int = 1, partialWindows:
}
/**
* Returns a sequence of pairs built from elements of both sequences with same indexes.
* Resulting sequence has length of shortest input sequence.
* Returns a sequence of values built from the elements of `this` sequence and the [other] sequence with the same index.
* The resulting sequence ends as soon as the shortest input sequence ends.
*
* @sample samples.collections.Sequences.Transformations.zip
*
@@ -1569,7 +1569,9 @@ public infix fun <T, R> Sequence<T>.zip(other: Sequence<R>): Sequence<Pair<T, R>
}
/**
* Returns a sequence of values built from elements of both collections with same indexes using provided [transform]. Resulting sequence has length of shortest input sequences.
* Returns a sequence of values built from the elements of `this` sequence and the [other] sequence with the same index
* using the provided [transform] function applied to each pair of elements.
* The resulting sequence ends as soon as the shortest input sequence ends.
*
* @sample samples.collections.Sequences.Transformations.zipWithTransform
*
@@ -1312,7 +1312,8 @@ public fun <R> CharSequence.windowedSequence(size: Int, step: Int = 1, partialWi
}
/**
* Returns a list of pairs built from characters of both char sequences with same indexes. List has length of shortest char sequence.
* Returns a list of pairs built from the characters of `this` and the [other] char sequences with the same index
* The returned list has length of the shortest char sequence.
*
* @sample samples.text.Strings.zip
*/
@@ -1321,7 +1322,9 @@ public infix fun CharSequence.zip(other: CharSequence): List<Pair<Char, Char>> {
}
/**
* Returns a list of values built from characters of both char sequences with same indexes using provided [transform]. List has length of shortest char sequence.
* Returns a list of values built from the characters of `this` and the [other] char sequences with the same index
* using the provided [transform] function applied to each pair of characters.
* The returned list has length of the shortest char sequence.
*
* @sample samples.text.Strings.zipWithTransform
*/