Skip to content

コレクションのフィルタリング ​

フィルタリングは、コレクション処理において最も一般的なタスクの1つです。 Kotlinにおいて、フィルタリング条件は_述語(predicate)_によって定義されます。これはコレクションの要素を受け取ってブール値を返すラムダ関数です。true は渡された要素が述語に一致することを意味し、false はその逆を意味します。

標準ライブラリには、コレクションを1回の呼び出しでフィルタリングできる一連の拡張関数が含まれています。 これらの関数は元のコレクションを変更しないため、読み取り専用とミュータブル(可変)の両方のコレクションで利用できます。フィルタリング結果を操作するには、変数に代入するか、フィルタリング後に関数をチェーン(連結)します。

述語によるフィルタリング ​

基本的なフィルタリング関数は filter() です。 述語を指定して呼び出すと、filter() はそれに一致するコレクションの要素を返します。 List と Set のいずれの場合も、結果のコレクションは List になり、Map の場合は結果も Map になります。

kotlin
fun main() {
    val numbers = listOf("one", "two", "three", "four")  
    val longerThan3 = numbers.filter { it.length > 3 }
    println(longerThan3)

    val numbersMap = mapOf("key1" to 1, "key2" to 2, "key3" to 3, "key11" to 11)
    val filteredMap = numbersMap.filter { (key, value) -> key.endsWith("1") && value > 10}
    println(filteredMap)
}

filter() 内の述語は要素の値しかチェックできません。 フィルタで要素の位置(インデックス)を使用したい場合は、filterIndexed() を使用します。 これはインデックスと要素の値という2つの引数を取る述語を受け取ります。

否定条件でコレクションをフィルタリングするには、filterNot() を使用します。 これは述語が false を返す要素のリストを返します。

kotlin
fun main() {
    val numbers = listOf("one", "two", "three", "four")
    
    val filteredIdx = numbers.filterIndexed { index, s -> (index != 0) && (s.length < 5)  }
    val filteredNot = numbers.filterNot { it.length <= 3 }

    println(filteredIdx)
    println(filteredNot)
}

特定の型の要素をフィルタリングして要素の型を絞り込む関数もあります。

  • filterIsInstance() は、指定された型のコレクション要素を返します。List<Any> に対して呼び出すと、filterIsInstance<T>() は List<T> を返すため、その要素に対して T 型の関数を呼び出すことができます。

    kotlin
    fun main() {
        val numbers = listOf(null, 1, "two", 3.0, "four")
        println("All String elements in upper case:")
        numbers.filterIsInstance<String>().forEach {
            println(it.uppercase())
        }
    }
  • filterNotNull() は、すべての非null(non-nullable)要素を返します。List<T?> に対して呼び出すと、filterNotNull() は List<T: Any> を返すため、要素を非nullオブジェクトとして扱うことができます。

    kotlin
    fun main() {
        val numbers = listOf(null, "one", "two", null)
        numbers.filterNotNull().forEach {
            println(it.length)   // null許容Stringではlengthは使用できません
        }
    }

パーティション ​

もう1つのフィルタリング関数である partition() は、述語によってコレクションをフィルタリングし、一致しなかった要素を別のリストに保持します。 そのため、戻り値として List の Pair が得られます。最初のリストには述語に一致した要素が含まれ、2番目のリストには元のコレクションの残りのすべての要素が含まれます。

kotlin
fun main() {
    val numbers = listOf("one", "two", "three", "four")
    val (match, rest) = numbers.partition { it.length > 3 }

    println(match)
    println(rest)
}

述語のテスト ​

最後に、コレクションの要素に対して述語を単にテストする関数があります。

  • any() は、指定された述語に一致する要素が少なくとも1つある場合に true を返します。
  • none() は、指定された述語に一致する要素が1つもない場合に true を返します。
  • all() は、すべての要素が指定された述語に一致する場合に true を返します。 空のコレクションに対して有効な述語を指定して all() を呼び出した場合、true を返すことに注意してください。このような振る舞いは論理学において_空虚な真(vacuous truth)_として知られています。
kotlin
fun main() {
    val numbers = listOf("one", "two", "three", "four")

    println(numbers.any { it.endsWith("e") })
    println(numbers.none { it.endsWith("a") })
    println(numbers.all { it.endsWith("e") })

    println(emptyList<Int>().all { it > 5 })   // 空虚な真(vacuous truth)
}

any() と none() は述語なしで使用することもできます。この場合、単にコレクションが空かどうかをチェックします。 any() は要素が存在する場合は true、存在しない場合は false を返します。none() はその逆を行います。

kotlin
fun main() {
    val numbers = listOf("one", "two", "three", "four")
    val empty = emptyList<String>()

    println(numbers.any())
    println(empty.any())
    
    println(numbers.none())
    println(empty.none())
}