発注

要素の順序は、特定のコレクション型において重要な側面です。例えば、要素が同じリストでも、要素の順序が異なると等しいとは見なされません。

Kotlinでは、オブジェクトの順序をいくつかの方法で定義できます。

まず、_自然_順序があります。これは、Comparable インターフェースの実装に対して定義されます。自然順序は、特に指定がない場合にそれらをソートするために使用されます。

ほとんどの組み込み型は比較可能です。

数値型は、従来の数値順序を使用します。1 は 0 より大きく、-3.4f は -5f より大きくなります。
CharとStringは、辞書式順序を使用します。b は a より大きく、world は hello より大きくなります。

ユーザー定義型に自然順序を定義するには、その型を Comparable の実装者にします。これには、compareTo() 関数を実装する必要があります。compareTo() は、引数として同じ型の別のオブジェクトを取り、どのオブジェクトが大きいかを示す整数値を返す必要があります。

正の値は、レシーバーオブジェクトが大きいことを示します。
負の値は、引数よりも小さいことを示します。
ゼロは、オブジェクトが等しいことを示します。

以下は、majorとminorパートで構成されるバージョンを順序付けるためのクラスです。

class Version(val major: Int, val minor: Int): Comparable<Version> {
    override fun compareTo(other: Version): Int = when {
        this.major != other.major `->` this.major compareTo other.major // compareTo() in the infix form 
        this.minor != other.minor `->` this.minor compareTo other.minor
        else `->` 0
    }
}

fun main() {    
    println(Version(1, 2) > Version(1, 3))
    println(Version(2, 0) > Version(1, 5))
}

_カスタム_順序を使用すると、任意の型のインスタンスを好きなようにソートできます。特に、比較不可能なオブジェクトの順序を定義したり、比較可能な型に対して自然順序以外の順序を定義したりできます。型にカスタム順序を定義するには、その型のComparatorを作成します。 Comparatorにはcompare()関数が含まれています。これは、クラスの2つのインスタンスを取り、それらの間の比較の整数結果を返します。結果は、上記のcompareTo()の結果と同じように解釈されます。

fun main() {

    val lengthComparator = Comparator { str1: String, str2: String `->` str1.length - str2.length }
    println(listOf("aaa", "bb", "c").sortedWith(lengthComparator))

}

lengthComparatorを使用すると、デフォルトの辞書式順序ではなく、文字列を長さで並べ替えることができます。

Comparatorを定義するより短い方法は、標準ライブラリのcompareBy() 関数です。compareBy()は、インスタンスからComparable値を生成するラムダ関数を取り、カスタム順序を生成された値の自然順序として定義します。

compareBy()を使用すると、上記の例の長さコンパレータは次のようになります。

fun main() {

    println(listOf("aaa", "bb", "c").sortedWith(compareBy { it.length }))

}

複数の基準に基づいて順序を定義することもできます。たとえば、文字列を長さでソートし、長さが等しい場合はアルファベット順にソートするには、次のように記述します。

fun main() {

    val sortedStrings = listOf("aaa", "bb", "c", "b", "a", "aa", "ccc")
        .sortedWith { a, b `->` 
           when (val compareLengths = a.length.compareTo(b.length)) {
             0 `->` a.compareTo(b)
             else `->` compareLengths
           }
         }

    println(sortedStrings)
    // [a, b, c, aa, bb, aaa, ccc]

}

複数の基準でソートすることは一般的なシナリオであるため、Kotlin標準ライブラリは、セカンダリソート規則を追加するために使用できるthenBy()関数を提供します。

たとえば、compareBy()をthenBy()と組み合わせて、前の例のように、最初に文字列を長さでソートし、次にアルファベット順にソートできます。

fun main() {

    val sortedStrings = listOf("aaa", "bb", "c", "b", "a", "aa", "ccc")
        .sortedWith(compareBy<String> { it.length }.thenBy { it })

    println(sortedStrings)
    // [a, b, c, aa, bb, aaa, ccc]

}

Kotlinコレクションパッケージは、自然順序、カスタム順序、さらにはランダム順序でコレクションをソートするための関数を提供します。このページでは、読み取り専用コレクションに適用されるソート関数について説明します。これらの関数は、元のコレクションの要素を要求された順序で含む新しいコレクションとして結果を返します。 mutableコレクションをインプレースでソートするための関数については、リスト固有の操作を参照してください。

自然順序

基本的な関数sorted()とsortedDescending() は、コレクションの要素を自然順序に従って昇順および降順にソートして返します。これらの関数は、Comparable要素のコレクションに適用されます。

fun main() {

    val numbers = listOf("one", "two", "three", "four")

    println("Sorted ascending: ${numbers.sorted()}")
    println("Sorted descending: ${numbers.sortedDescending()}")

}

カスタム順序

カスタム順序でソートする場合、または比較不可能なオブジェクトをソートする場合は、sortedBy()とsortedByDescending()関数があります。これらは、コレクション要素をComparable値にマップするセレクター関数を取り、その値の自然順序でコレクションをソートします。

fun main() {

    val numbers = listOf("one", "two", "three", "four")

    val sortedNumbers = numbers.sortedBy { it.length }
    println("Sorted by length ascending: $sortedNumbers")
    val sortedByLast = numbers.sortedByDescending { it.last() }
    println("Sorted by the last letter descending: $sortedByLast")

}

コレクションのソートにカスタム順序を定義するには、独自のComparatorを提供できます。これを行うには、Comparatorを渡してsortedWith()関数を呼び出します。この関数を使用すると、文字列を長さでソートすると次のようになります。

fun main() {

    val numbers = listOf("one", "two", "three", "four")
    println("Sorted by length ascending: ${numbers.sortedWith(compareBy { it.length })}")

}

逆順

reversed()関数を使用して、コレクションを逆順で取得できます。

fun main() {

    val numbers = listOf("one", "two", "three", "four")
    println(numbers.reversed())

}

reversed()は、要素のコピーを含む新しいコレクションを返します。したがって、後で元のコレクションを変更しても、以前に取得したreversed()の結果には影響しません。

別の反転関数 - asReversed()

は、同じコレクションインスタンスの反転ビューを返します。したがって、元のリストが変更されない場合は、reversed()よりも軽量で推奨される場合があります。

fun main() {

    val numbers = listOf("one", "two", "three", "four")
    val reversedNumbers = numbers.asReversed()
    println(reversedNumbers)

}

元のリストがmutableの場合、そのすべての変更が反転ビューに反映され、その逆も同様です。

fun main() {

    val numbers = mutableListOf("one", "two", "three", "four")
    val reversedNumbers = numbers.asReversed()
    println(reversedNumbers)
    numbers.add("five")
    println(reversedNumbers)

}

ただし、リストのmutabilityが不明な場合、またはソースがリストではない場合、reversed()の方が推奨されます。その結果はコピーであり、将来変更されないためです。

ランダム順序

最後に、コレクション要素をランダムな順序で含む新しいListを返す関数があります - shuffled()。引数なしで、またはRandomオブジェクトを使用して呼び出すことができます。

fun main() {

     val numbers = listOf("one", "two", "three", "four")
     println(numbers.shuffled())

}

自然順序​

カスタム順序​

逆順​

ランダム順序​

自然順序

カスタム順序

逆順

ランダム順序