| layout | title |
|---|---|
reference |
コレクションのオペレーション概要 |
Kotlinの標準ライブラリはコレクションに対する幅広いオペレーションを実行するための様々な関数を提供しています。 これらの中には単なる要素の取得や追加などの基本的なものから、より複雑な検索、ソート、フィルタ、トランスフォーム（変形）などまで様々なものがあります。
標準ライブラリでは、コレクションのオペレーションは２つの形態で定義されています：コレクションのインターフェースにメンバ関数として、 あるいは拡張関数(extension function)として。
メンバ関数はコレクションの型にとって必須のオペレーションを定義します。
例えば、 Collectionは自身が空かどうかをチェックする為に isEmpty()関数があり、
Listには要素にアクセスする為に
get()がある、などです。
あなたがコレクションのインターフェースの独自の実装を作りたい、と思ったら、そのメンバ関数を実装する必要があります。
新規の実装を簡単にする為に、標準ライブラリのスケルトン的な実装を使用する事が出来ます：
AbstractCollection、
AbstractList、
AbstractSet、
AbstractMapと、
そのmutableバージョンです。
必須でないそれ以外のオペレーションは拡張関数として宣言されています。 これらには、フィルタ、トランスフォーム、並べかえ、そのほかのコレクションの処理関数などが該当します。
共通のオペレーションは、読み取り専用とミュータブルなコレクションの両方で使う事が出来ます。 共通のオペレーションは以下のグループに分ける事が出来ます：
- トランスフォーム
- フィルタ（Filtering）
plusとminusオペレータ- グルーピング
- 部分コレクションの取り出し
- 一つの要素の取り出し
- 並べ替え
- 集約オペレーション（Aggregate operations）
これらのページに書かれているオペレーションは、どれも元となるコレクションには影響を与えません。 例えば、フィルタオペレーションは、フィルタの述語（predicate）に位置する要素を含む新しいコレクションを作り出します。 そのようにして得られた結果は変数に格納したり、その他の用途、例えば別の関数に渡したり出来ます。
{% capture collection-operation-1 %}
fun main() {
//sampleStart
val numbers = listOf("one", "two", "three", "four")
numbers.filter { it.length > 3 } // numbersには何の影響も無い。結果は捨てられる。
println("numbers は依然として $numbers")
val longerThan3 = numbers.filter { it.length > 3 } // 結果はlongerThan3に格納される
println("3文字より長い numbers は $longerThan3")
//sampleEnd
}
{% endcapture %}
{% include kotlin_quote.html body=collection-operation-1 %}
幾つかのコレクションのオペレーションには、**行き先（destination）**オブジェクトを指定するものもあります。
行き先オブジェクトは、ミュータブルなコレクションで、これを取るオペレーションはオペレーションの結果を新規のコレクションとして返すのでは無く、この行き先オブジェクトに追加していきます。
行き先つきのオペレーションは、それを行うToが末尾についた関数を使う事になります。
例えば、filter() の代わりに
filterTo() を使ったり、
associate()の代わりにassociateTo()を使う、
といった具合に。
これらのToが末尾につく関数は、行き先となるコレクションを追加のパラメータとして引数に取ります。
{% capture destination-sample %}
fun main() { //sampleStart val numbers = listOf("one", "two", "three", "four") val filterResults = mutableListOf() // 行き先オブジェクト numbers.filterTo(filterResults) { it.length > 3 } numbers.filterIndexedTo(filterResults) { index, _ -> index == 0 } println(filterResults) // 両方のオペレーションの結果を含んでいる //sampleEnd }
{% endcapture %} {% include kotlin_quote.html body=destination-sample %}
利便性のために、これらの関数は行き先オブジェクトを返します。 これを活用すれば、関数呼び出しをする時の行き先オブジェクトに対応する引数の所で新規の行き先オブジェクトを作る、なんて事が出来ます：
{% capture destination-return %}
fun main() { val numbers = listOf("one", "two", "three", "four") //sampleStart // numbersをフィルタして新しく作ったハッシュセットに入れる。 // こうしてresultに入る要素（長さ）の重複を除去している // （訳注：numbersの単語のlengthのセットを作ってresultとしている） val result = numbers.mapTo(HashSet()) { it.length } println("重複を除いた長さたちは： $result") //sampleEnd } {% endcapture %} {% include kotlin_quote.html body=destination-return %}
行き先指定つきの関数で用意されてるものとしては、フィルタ、関連付け（association）、グルーピング、フィルタリングなどがあります。 行き先指定つきの全オペレーションを知りたければ、Kotlinコレクションリファレンスを参照ください。
ミュータブルなコレクションには、ここまで述べてきたものに加えて**書き込みオペレーション（write operations）**があり、 これはコレクションの状態を変更します。 そのようなオペレーションには、要素の追加、削除、更新などが含まれます。 書き込みオペレーションは書き込みオペレーションのページと、 List特有のオペレーション と マップ特有のオペレーションのそれ系のセクションに書かれています。
ある種のオペレーションに関しては、同じオペレーションを行うペアの関数があります：
一つはオペレーションをそのコレクション自身に（in-placeで）行うものと、
もう一つは別個の新しいコレクションとして結果を返すものの２つです。
例えば、sort()はミュータブルなコレクションをin-placeでソートし、つまりはそのコレクション自身の状態を変更するのに対し、
sorted()は同じ要素をソートした順番に収めた新しいコレクションを作ります。
{% capture sort-sorted %}
fun main() { //sampleStart val numbers = mutableListOf("one", "two", "three", "four") val sortedNumbers = numbers.sorted() println(numbers == sortedNumbers) // false numbers.sort() println(numbers == sortedNumbers) // true //sampleEnd } {% endcapture %} {% include kotlin_quote.html body=sort-sorted %}