コレクションの概要

Kotlin標準ライブラリは、_コレクション_を管理するための包括的なツールセットを提供します。コレクションとは、解決される問題にとって重要であり、一般的に操作される可変数の項目（ゼロの場合もあります）のグループです。

コレクションはほとんどのプログラミング言語にとって一般的な概念であるため、例えばJavaやPythonのコレクションに慣れている場合は、この序論をスキップして詳細なセクションに進むことができます。

コレクションには通常、同じ型（およびそのサブタイプ）のオブジェクトが多数含まれます。コレクション内のオブジェクトは_要素_または_項目_と呼ばれます。例えば、ある学科の全学生は、平均年齢を計算するために使用できるコレクションを形成します。

以下のコレクション型がKotlinに関連しています。

• _リスト_は、順序付けられたコレクションであり、要素の位置を反映する整数であるインデックスによって要素にアクセスできます。要素はリスト内で複数回出現することができます。リストの例としては電話番号があります。これは数字のグループであり、その順序が重要で、繰り返すことができます。
• _セット_は、ユニークな要素のコレクションです。これは、繰り返しがないオブジェクトのグループという数学的な集合の抽象化を反映しています。通常、セット要素の順序は意味を持ちません。例えば、宝くじの数字はセットを形成します。それらはユニークであり、順序は重要ではありません。
• マップ（または_辞書_）は、キーと値のペアのセットです。キーはユニークであり、それぞれのキーが正確に1つの値にマッピングされます。値は重複可能です。マップは、オブジェクト間の論理的な接続を格納するのに便利です。例えば、従業員のIDとその役職などです。

Kotlinでは、格納されているオブジェクトの正確な型に関係なく、コレクションを操作できます。言い換えれば、StringのリストにStringを追加する方法は、Intやユーザー定義クラスの場合と同じです。 そのため、Kotlin標準ライブラリは、あらゆる型のコレクションを作成、投入、および管理するためのジェネリックなインターフェース、クラス、および関数を提供します。

コレクションインターフェースと関連関数は、kotlin.collectionsパッケージにあります。その内容の概要を見てみましょう。

配列はコレクションの一種ではありません。詳細については、配列を参照してください。

コレクション型

Kotlin標準ライブラリは、基本的なコレクション型（セット、リスト、マップ）の実装を提供します。 各コレクション型は一対のインターフェースで表されます。

• コレクション要素にアクセスするための操作を提供する_読み取り専用_インターフェース。
• 対応する読み取り専用インターフェースを書き込み操作（要素の追加、削除、更新）で拡張する_可変_インターフェース。

なお、可変コレクションはvarに割り当てる必要はありません。可変コレクションがvalに割り当てられていても、書き込み操作は可能です。可変コレクションをvalに割り当てる利点は、可変コレクションへの参照が変更されるのを防ぐことができる点です。時間と共にコードが成長し複雑になるにつれて、意図しない参照の変更を防ぐことはさらに重要になります。より安全で堅牢なコードのために、可能な限りvalを使用してください。valコレクションを再割り当てしようとすると、コンパイルエラーになります。

fun main() {
    val numbers = mutableListOf("one", "two", "three", "four")
    numbers.add("five")   // this is OK
    println(numbers)
    //numbers = mutableListOf("six", "seven")      // compilation error

}

読み取り専用のコレクション型は共変です。 これはつまり、RectangleクラスがShapeから継承している場合、List<Shape>が必要な場所であればどこでもList<Rectangle>を使用できるということです。 言い換えれば、コレクション型は要素型と同じサブタイピング関係を持ちます。マップは値型に対しては共変ですが、キー型に対してはそうではありません。

一方、可変コレクションは共変ではありません。そうでなければ、ランタイムエラーにつながるでしょう。もしMutableList<Rectangle>がMutableList<Shape>のサブタイプであった場合、他のShapeの継承者（例えばCircle）を挿入することができ、そのRectangle型引数を侵害することになります。

以下はKotlinのコレクションインターフェースの図です。

インターフェースとその実装を見ていきましょう。Collectionについて学ぶには、以下のセクションを読んでください。List、Set、Mapについて学ぶには、対応するセクションを読むか、Kotlin Developer AdvocateのSebastian Aignerによるビデオを視聴することもできます。

Collection

Collection<T>はコレクション階層のルートです。このインターフェースは、読み取り専用コレクションの共通の振る舞い（サイズの取得、項目のメンバーシップの確認など）を表します。 Collectionは、要素をイテレートするための操作を定義するIterable<T>インターフェースを継承しています。Collectionは、異なるコレクション型に適用される関数のパラメータとして使用できます。より具体的なケースでは、Collectionの継承者であるListとSetを使用します。

fun printAll(strings: Collection<String>) {
    for(s in strings) print("$s ")
    println()
}
    
fun main() {
    val stringList = listOf("one", "two", "one")
    printAll(stringList)
    
    val stringSet = setOf("one", "two", "three")
    printAll(stringSet)
}

MutableCollection<T>は、addやremoveなどの書き込み操作を持つCollectionです。

fun List<String>.getShortWordsTo(shortWords: MutableList<String>, maxLength: Int) {
    this.filterTo(shortWords) { it.length <= maxLength }
    // throwing away the articles
    val articles = setOf("a", "A", "an", "An", "the", "The")
    shortWords -= articles
}

fun main() {
    val words = "A long time ago in a galaxy far far away".split(" ")
    val shortWords = mutableListOf<String>()
    words.getShortWordsTo(shortWords, 3)
    println(shortWords)
}

List

List<T>は、要素を指定された順序で格納し、それらへのインデックスアクセスを提供します。インデックスはゼロ（最初の要素のインデックス）から始まり、list.size - 1であるlastIndexまで続きます。

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    println("Number of elements: ${numbers.size}")
    println("Third element: ${numbers.get(2)}")
    println("Fourth element: ${numbers[3]}")
    println("Index of element \"two\" ${numbers.indexOf("two")}")
}

リスト要素（nullを含む）は重複可能です。リストには、等しいオブジェクトがいくつでも、または単一のオブジェクトが複数回出現することができます。 2つのリストは、同じサイズで、同じ位置に構造的に等しい要素がある場合に等しいと見なされます。

data class Person(var name: String, var age: Int)

fun main() {
    val bob = Person("Bob", 31)
    val people = listOf(Person("Adam", 20), bob, bob)
    val people2 = listOf(Person("Adam", 20), Person("Bob", 31), bob)
    println(people == people2)
    bob.age = 32
    println(people == people2)
}

MutableList<T>は、リスト固有の書き込み操作を持つListです。例えば、特定の位置に要素を追加または削除するなどです。

fun main() {
    val numbers = mutableListOf(1, 2, 3, 4)
    numbers.add(5)
    numbers.removeAt(1)
    numbers[0] = 0
    numbers.shuffle()
    println(numbers)
}

ご覧のとおり、いくつかの点でリストは配列と非常によく似ています。 ただし、1つの重要な違いがあります。配列のサイズは初期化時に定義され、変更されることはありません。一方、リストには事前に定義されたサイズがありません。リストのサイズは、要素の追加、更新、削除などの書き込み操作の結果として変更できます。

Kotlinでは、MutableListのデフォルト実装はArrayListであり、リサイズ可能な配列と考えることができます。

Set

Set<T>はユニークな要素を格納します。要素の順序は通常未定義です。null要素もユニークです。Setは1つのnullしか含めることができません。2つのセットは、同じサイズであり、一方のセットの各要素に対して他方のセットに等しい要素がある場合に等しいと見なされます。

fun main() {
    val numbers = setOf(1, 2, 3, 4)
    println("Number of elements: ${numbers.size}")
    if (numbers.contains(1)) println("1 is in the set")

    val numbersBackwards = setOf(4, 3, 2, 1)
    println("The sets are equal: ${numbers == numbersBackwards}")
}

MutableSetは、MutableCollectionからの書き込み操作を持つSetです。

MutableSetのデフォルト実装であるLinkedHashSetは、要素の挿入順序を保持します。 そのため、first()やlast()など、順序に依存する関数は、そのようなセットに対して予測可能な結果を返します。

fun main() {
    val numbers = setOf(1, 2, 3, 4)  // LinkedHashSet is the default implementation
    val numbersBackwards = setOf(4, 3, 2, 1)
    
    println(numbers.first() == numbersBackwards.first())
    println(numbers.first() == numbersBackwards.last())
}

代替の実装であるHashSetは要素の順序については何も言及していないため、そのような関数を呼び出すと予測不可能な結果が返されます。ただし、HashSetは同じ数の要素を格納するためにより少ないメモリを必要とします。

Map

Map<K, V>はCollectionインターフェースの継承者ではありませんが、これもKotlinのコレクション型です。 Mapは_キーと値_のペア（または_エントリ_）を格納します。キーはユニークですが、異なるキーが同じ値とペアになることがあります。Mapインターフェースは、キーによる値へのアクセス、キーと値の検索など、特定の機能を提供します。

fun main() {
    val numbersMap = mapOf("key1" to 1, "key2" to 2, "key3" to 3, "key4" to 1)
    
    println("All keys: ${numbersMap.keys}")
    println("All values: ${numbersMap.values}")
    if ("key2" in numbersMap) println("Value by key \"key2\": ${numbersMap["key2"]}")    
    if (1 in numbersMap.values) println("The value 1 is in the map")
    if (numbersMap.containsValue(1)) println("The value 1 is in the map") // same as previous
}

等しいペアを含む2つのマップは、ペアの順序に関係なく等しいと見なされます。

fun main() {
    val numbersMap = mapOf("key1" to 1, "key2" to 2, "key3" to 3, "key4" to 1)    
    val anotherMap = mapOf("key2" to 2, "key1" to 1, "key4" to 1, "key3" to 3)
    
    println("The maps are equal: ${numbersMap == anotherMap}")
}

MutableMapは、マップの書き込み操作を持つMapです。例えば、新しいキーと値のペアを追加したり、指定されたキーに関連付けられた値を更新したりできます。

fun main() {
    val numbersMap = mutableMapOf("one" to 1, "two" to 2)
    numbersMap.put("three", 3)
    numbersMap["one"] = 11

    println(numbersMap)
}

MutableMapのデフォルト実装であるLinkedHashMapは、マップをイテレートする際に要素の挿入順序を保持します。 一方、代替の実装であるHashMapは要素の順序については何も言及していません。

ArrayDeque

ArrayDeque<T>は両端キューの実装であり、キューの先頭または末尾の両方で要素を追加または削除できます。 そのため、ArrayDequeはKotlinにおいて、スタックとキューの両方のデータ構造としての役割も果たします。内部的には、ArrayDequeは必要に応じてサイズが自動的に調整される可変サイズ配列を使用して実現されています。

fun main() {
    val deque = ArrayDeque(listOf(1, 2, 3))

    deque.addFirst(0)
    deque.addLast(4)
    println(deque) // [0, 1, 2, 3, 4]

    println(deque.first()) // 0
    println(deque.last()) // 4

    deque.removeFirst()
    deque.removeLast()
    println(deque) // [1, 2, 3]
}