W3cubDocs

/Kotlin

chunked

fun <T> Iterable<T>.chunked(size: Int): List<List<T>>

Platform and version requirements: Kotlin 1.2

Splits this collection into a list of lists each not exceeding the given size.

The last list in the resulting list may have less elements than the given size.

import kotlin.test.*

fun main(args: Array<String>) {
//sampleStart
val words = "one two three four five six seven eight nine ten".split(' ')
val chunks = words.chunked(3)

println(chunks) // [[one, two, three], [four, five, six], [seven, eight, nine], [ten]]
//sampleEnd
}

Parameters

size - the number of elements to take in each list, must be positive and can be greater than the number of elements in this collection.

fun <T, R> Iterable<T>.chunked(
    size: Int, 
    transform: (List<T>) -> R
): List<R>

Platform and version requirements: Kotlin 1.2

Splits this collection into several lists each not exceeding the given size and applies the given transform function to an each.

import kotlin.test.*
import java.util.*

fun main(args: Array<String>) {
//sampleStart
val codonTable = mapOf("ATT" to "Isoleucine", "CAA" to "Glutamine", "CGC" to "Arginine", "GGC" to "Glycine")
val dnaFragment = "ATTCGCGGCCGCCAA"

val proteins = dnaFragment.chunked(3) { codon: CharSequence -> codonTable[codon.toString()] ?: error("Unknown codon") }

println(proteins) // [Isoleucine, Arginine, Glycine, Arginine, Glutamine]
//sampleEnd
}

Parameters

size - the number of elements to take in each list, must be positive and can be greater than the number of elements in this collection.

Return

list of results of the transform applied to an each list.

Note that the list passed to the transform function is ephemeral and is valid only inside that function. You should not store it or allow it to escape in some way, unless you made a snapshot of it. The last list may have less elements than the given size.

© 2010–2018 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/chunked.html