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

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

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

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

基本的なフィルタリング関数は 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() は、述語によってコレクションをフィルタリングし、一致しない要素を別のリストに保持します。 そのため、戻り値として 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 を返します。このような振る舞いは、論理学では_空虚な真_として知られています。

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