Listに特有の操作

ListはKotlinで最も一般的な組み込みコレクションの型です。リストの要素へのインデックスアクセスは、リストに対して強力な操作のセットを提供します。

インデックスによる要素の取得

リストは、要素の取得に関するすべての共通操作をサポートしています。elementAt()、first()、last()、および単一の要素の取得に記載されているその他の操作が含まれます。 リストに特有なのは要素へのインデックスアクセスであり、要素を読み取る最も簡単な方法はインデックスによって取得することです。これは、引数にインデックスを渡すget()関数、または短縮形の[index]構文で実行できます。

リストのサイズが指定されたインデックスよりも小さい場合、例外がスローされます。 そのような例外を回避するのに役立つ他の2つの関数があります。

• getOrElse()は、コレクションにインデックスが存在しない場合に返すデフォルト値を計算するための関数を提供できます。
• getOrNull()は、デフォルト値としてnullを返します。

fun main() {
    val numbers = listOf(1, 2, 3, 4)
    println(numbers.get(0))
    println(numbers[0])
    //numbers.get(5)                         // exception!
    println(numbers.getOrNull(5))             // null
    println(numbers.getOrElse(5, {it}))        // 5
}

リストの一部の取得

コレクションの一部の取得に関する共通操作に加えて、リストは指定された要素の範囲のビューをリストとして返すsubList()関数を提供します。 したがって、元のコレクションの要素が変更されると、以前に作成されたサブリストでも変更され、その逆もまた然りです。

fun main() {
    val numbers = (0..13).toList()
    println(numbers.subList(3, 6))
}

要素の位置の検索

線形探索

任意のリストで、indexOf()およびlastIndexOf()関数を使用して要素の位置を見つけることができます。 これらは、リスト内で与えられた引数と等しい要素の最初と最後の位置を返します。 そのような要素がない場合、どちらの関数も-1を返します。

fun main() {
    val numbers = listOf(1, 2, 3, 4, 2, 5)
    println(numbers.indexOf(2))
    println(numbers.lastIndexOf(2))
}

また、述語を受け取り、それに一致する要素を検索する関数のペアもあります。

• indexOfFirst()は、述語に一致する最初の要素のインデックスを返します。そのような要素がない場合は-1を返します。
• indexOfLast()は、述語に一致する最後の要素のインデックスを返します。そのような要素がない場合は-1を返します。

fun main() {
    val numbers = mutableListOf(1, 2, 3, 4)
    println(numbers.indexOfFirst { it > 2})
    println(numbers.indexOfLast { it % 2 == 1})
}

ソート済みリストでの二分探索

リスト内の要素を検索するもう1つの方法として、二分探索があります。 これは、他の組み込み検索関数よりも大幅に高速に動作しますが、リストが特定の順序（自然順序または関数パラメータで提供される別の順序）に従って昇順にソートされている必要があります。 そうでない場合、結果は未定義です。

ソートされたリストで要素を検索するには、値を引数として渡してbinarySearch()関数を呼び出します。 そのような要素が存在する場合、関数はそのインデックスを返します。存在しない場合、(-insertionPoint - 1)を返します。ここで、insertionPointはその要素が挿入されるべきインデックスであり、リストがソートされた状態を保つようにします。 指定された値を持つ要素が複数ある場合、検索はそのいずれかのインデックスを返すことがあります。

検索するインデックス範囲を指定することもできます。この場合、関数は指定された2つのインデックス間のみを検索します。

fun main() {
    val numbers = mutableListOf("one", "two", "three", "four")
    numbers.sort()
    println(numbers)
    println(numbers.binarySearch("two"))  // 3
    println(numbers.binarySearch("z")) // -5
    println(numbers.binarySearch("two", 0, 2))  // -3
}

コンパレータによる二分探索

リストの要素がComparableでない場合、二分探索で使用するComparatorを提供する必要があります。 リストはこのComparatorに従って昇順にソートされている必要があります。例を見てみましょう。

data class Product(val name: String, val price: Double)

fun main() {
    val productList = listOf(
        Product("WebStorm", 49.0),
        Product("AppCode", 99.0),
        Product("DotTrace", 129.0),
        Product("ReSharper", 149.0))

    println(productList.binarySearch(Product("AppCode", 99.0), compareBy<Product> { it.price }.thenBy { it.name }))
}

ここでは、ComparableではないProductインスタンスのリストと、順序を定義するComparatorがあります。製品p1の価格がp2の価格より低い場合、製品p1は製品p2より前に来ます。 したがって、この順序に従って昇順にソートされたリストがあれば、binarySearch()を使用して指定されたProductのインデックスを見つけることができます。

カスタムコンパレータは、リストが自然順序とは異なる順序を使用する場合にも便利です。たとえば、String要素の大文字と小文字を区別しない順序などです。

fun main() {
    val colors = listOf("Blue", "green", "ORANGE", "Red", "yellow")
    println(colors.binarySearch("RED", String.CASE_INSENSITIVE_ORDER)) // 3
}

比較関数による二分探索

_比較_関数による二分探索では、明示的な検索値を提供せずに要素を見つけることができます。 代わりに、要素をInt値にマッピングする比較関数を受け取り、その関数がゼロを返す要素を検索します。 リストは、提供された関数に従って昇順にソートされている必要があります。言い換えれば、比較の戻り値はリストの要素が次々と増加するにつれて増大する必要があります。

import kotlin.math.sign
data class Product(val name: String, val price: Double)

fun priceComparison(product: Product, price: Double) = sign(product.price - price).toInt()

fun main() {
    val productList = listOf(
        Product("WebStorm", 49.0),
        Product("AppCode", 99.0),
        Product("DotTrace", 129.0),
        Product("ReSharper", 149.0))

    println(productList.binarySearch { priceComparison(it, 99.0) })
}

コンパレータと比較関数による二分探索は、リストの範囲に対しても実行できます。

リストの書き込み操作

コレクションの書き込み操作で説明されているコレクション変更操作に加えて、可変リストは特定の書き込み操作をサポートしています。 これらの操作はインデックスを使用して要素にアクセスし、リストの変更機能を拡張します。

追加

リストの特定の位置に要素を追加するには、要素挿入位置を追加引数として提供するadd()およびaddAll()を使用します。 その位置より後に来るすべての要素は右にシフトします。

fun main() {
    val numbers = mutableListOf("one", "five", "six")
    numbers.add(1, "two")
    numbers.addAll(2, listOf("three", "four"))
    println(numbers)
}

更新

リストは、指定された位置の要素を置換する関数set()とその演算子形式[]も提供します。 set()は他の要素のインデックスを変更しません。

fun main() {
    val numbers = mutableListOf("one", "five", "three")
    numbers[1] =  "two"
    println(numbers)
}

fill()は、コレクションのすべての要素を指定された値で単純に置き換えます。

fun main() {
    val numbers = mutableListOf(1, 2, 3, 4)
    numbers.fill(3)
    println(numbers)
}

削除

リストの特定の位置から要素を削除するには、位置を引数として提供するremoveAt()関数を使用します。 削除される要素より後に来るすべての要素のインデックスは1つ減少します。

fun main() {
    val numbers = mutableListOf(1, 2, 3, 4, 3)    
    numbers.removeAt(1)
    println(numbers)
}

ソート

コレクションの順序付けでは、特定の順序でコレクション要素を取得する操作について説明しています。 可変リストの場合、標準ライブラリは、同じ順序付け操作をインプレースで実行する同様の拡張関数を提供します。 そのような操作をリストインスタンスに適用すると、そのインスタンス内の要素の順序が変更されます。

インプレースソート関数は、読み取り専用リストに適用される関数と似た名前ですが、ed/dサフィックスがありません。

• すべてのソート関数名において、sorted*の代わりにsort*が使用されます。例: sort()、sortDescending()、sortBy()など。
• shuffled()の代わりにshuffle()。
• reversed()の代わりにreverse()。

可変リストに対して呼び出されるasReversed()は、元のリストを反転したビューである別の可変リストを返します。そのビューでの変更は、元のリストに反映されます。 次の例は、可変リストのソート関数を示しています。

fun main() {
    val numbers = mutableListOf("one", "two", "three", "four")

    numbers.sort()
    println("Sort into ascending: $numbers")
    numbers.sortDescending()
    println("Sort into descending: $numbers")

    numbers.sortBy { it.length }
    println("Sort into ascending by length: $numbers")
    numbers.sortByDescending { it.last() }
    println("Sort into descending by the last letter: $numbers")
    
    numbers.sortWith(compareBy<String> { it.length }.thenBy { it })
    println("Sort by Comparator: $numbers")

    numbers.shuffle()
    println("Shuffle: $numbers")

    numbers.reverse()
    println("Reverse: $numbers")
}