コレクション操作の概要

Kotlin標準ライブラリは、コレクションに対して操作を実行するための多種多様な関数を提供しています。これには、要素の取得や追加といった単純な操作から、検索、ソート、フィルタリング、変換などのより複雑な操作まで含まれます。

拡張関数とメンバ関数

コレクション操作は、標準ライブラリにおいて2つの方法で宣言されています。コレクションインターフェースのメンバ関数と拡張関数です。

メンバ関数は、コレクション型にとって不可欠な操作を定義します。例えば、Collection には、空かどうかを確認するための関数 isEmpty() が含まれています。List には要素にインデックスでアクセスするための get() などが含まれています。

独自のコレクションインターフェースの実装を作成する場合は、そのメンバ関数を実装する必要があります。新しい実装の作成を容易にするために、標準ライブラリにあるコレクションインターフェースの骨格実装（skeletal implementations）を使用してください：AbstractCollection、AbstractList、AbstractSet、AbstractMap、およびそれらのミュータブル（可変）な対応クラスです。

その他のコレクション操作は拡張関数として宣言されています。これらはフィルタリング、変換、順序付け、およびその他のコレクション処理関数です。

共通の操作

共通の操作は、読み取り専用コレクションとミュータブルコレクションの両方で利用可能です。共通の操作は以下のグループに分類されます：

• 変換（Transformations）
• フィルタリング（Filtering）
• plus および minus 演算子
• グループ化（Grouping）
• コレクションの一部の取得
• 単一要素の取得
• 順序付け（Ordering）
• 集計操作（Aggregate operations）

これらのページで説明されている操作は、元のコレクションに影響を与えずに結果を返します。例えば、フィルタリング操作は、フィルタリングの述語（predicate）に一致するすべての要素を含む新しいコレクションを生成します。このような操作の結果は、変数に格納するか、あるいは他の関数に渡すなど、別の方法で使用する必要があります。

fun main() {
    val numbers = listOf("one", "two", "three", "four")  
    numbers.filter { it.length > 3 }  // numbersには何も起こらず、結果は失われます
    println("numbers are still $numbers")
    val longerThan3 = numbers.filter { it.length > 3 } // 結果がlongerThan3に格納されます
    println("numbers longer than 3 chars are $longerThan3")
}

特定のコレクション操作では、宛先（destination）オブジェクトを指定するオプションがあります。宛先とは、関数が結果のアイテムを新しいオブジェクトとして返す代わりに、それらを追加するミュータブルなコレクションのことです。宛先を伴う操作を実行するために、名前に To 接尾辞を持つ個別の関数があります。例えば、filter() の代わりに filterTo()、あるいは associate() の代わりに associateTo() などがあります。これらの関数は、宛先コレクションを追加のパラメータとして受け取ります。

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    val filterResults = mutableListOf<String>()  // 宛先オブジェクト
    numbers.filterTo(filterResults) { it.length > 3 }
    numbers.filterIndexedTo(filterResults) { index, _ -> index == 0 }
    println(filterResults) // 両方の操作の結果が含まれます
}

便宜上、これらの関数は宛先コレクションを戻り値として返すため、関数呼び出しの引数内で直接作成することができます。

fun main() {
    val numbers = listOf("one", "two", "three", "four")
    // 数値を新しいハッシュセットに直接フィルタリングし、
    // 結果の重複を排除します
    val result = numbers.mapTo(HashSet()) { it.length }
    println("distinct item lengths are $result")
}

宛先を指定できる関数は、フィルタリング、関連付け（association）、グループ化、フラット化（flattening）、およびその他の操作で利用可能です。宛先操作の完全なリストについては、Kotlin collections reference を参照してください。

書き込み操作

ミュータブルなコレクションには、コレクションの状態を変更する書き込み操作（write operations）もあります。このような操作には、要素の追加、削除、および更新が含まれます。書き込み操作は、書き込み操作のセクション、およびリスト固有の操作とマップ固有の操作の対応するセクションに記載されています。

特定の操作には、同じ操作を実行するための関数のペアがあります。一方は操作をインプレース（直接）適用し、もう一方は結果を別のコレクションとして返します。例えば、sort() はミュータブルなコレクションをインプレースでソートするため、その状態が変化します。一方、sorted() は同じ要素をソートされた順序で含む新しいコレクションを作成します。

fun main() {
    val numbers = mutableListOf("one", "two", "three", "four")
    val sortedNumbers = numbers.sorted()
    println(numbers == sortedNumbers)  // false
    numbers.sort()
    println(numbers == sortedNumbers)  // true
}