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

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

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

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

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

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 になる要素のリストを返します。

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 型の関数を呼び出すことができます。

  fun main() {
      val numbers = listOf(null, 1, "two", 3.0, "four")
      println("すべての String 要素を大文字で:")
      numbers.filterIsInstance<String>().forEach {
          println(it.uppercase())
      }
  }

• filterNotNull() は、 すべての非 null 要素を返します。List<T?> に対して呼び出すと、filterNotNull() は List<T: Any> を返すため、 要素を非 null オブジェクトとして扱うことができます。

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

パーティション（Partition）

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

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() は、どの要素も指定された述語に一致しない場合に true を返します。
• all() は、すべての要素が指定された述語に一致する場合に true を返します。 なお、空のコレクションに対して有効な述語を指定して all() を呼び出すと true を返します。このような動作は、論理学では 空虚な真（vacuous truth） として知られています。

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 })   // 空虚な真
}

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

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())
}