シーケンス

コレクションと並んで、Kotlin標準ライブラリには別の型である_シーケンス_ (Sequence<T>)が含まれています。 コレクションとは異なり、シーケンスは要素を保持せず、イテレーション中に要素を生成します。 シーケンスはIterableと同じ関数を提供しますが、多段階コレクション処理に対して別のアプローチを実装しています。

Iterableの処理が複数のステップを含む場合、それらは即時実行されます。つまり、各処理ステップは完了し、その結果である中間コレクションを返します。次のステップはこのコレクションに対して実行されます。一方、シーケンスの多段階処理は可能な限り遅延実行されます。実際の計算は、処理チェーン全体の最終結果が要求されたときにのみ行われます。

操作の実行順序も異なります。Sequenceはすべての処理ステップを、各要素に対して1つずつ実行します。一方、Iterableは各ステップをコレクション全体に対して完了させてから、次のステップに進みます。

したがって、シーケンスを使用すると、中間ステップの結果を構築することを避けられるため、コレクション処理チェーン全体のパフォーマンスが向上します。ただし、シーケンスの遅延的な性質は、小さなコレクションを処理する場合や単純な計算を行う場合に、無視できないオーバーヘッドを追加する可能性があります。そのため、SequenceとIterableの両方を考慮し、どちらが自身のケースに適しているかを判断する必要があります。

構築

要素から

シーケンスを作成するには、要素を引数としてリストするsequenceOf()関数を呼び出します。

val numbersSequence = sequenceOf("four", "three", "two", "one")

Iterableから

既存のIterableオブジェクト（ListやSetなど）がある場合は、asSequence()を呼び出すことで、それからシーケンスを作成できます。

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

関数から

シーケンスを作成するもう1つの方法は、要素を計算する関数を使用して構築することです。 関数に基づいてシーケンスを構築するには、その関数を引数としてgenerateSequence()を呼び出します。オプションで、最初の要素を明示的な値として、または関数呼び出しの結果として指定できます。 指定された関数がnullを返すと、シーケンスの生成は停止します。したがって、以下の例のシーケンスは無限です。

fun main() {
    val oddNumbers = generateSequence(1) { it + 2 } // `it` is the previous element
    println(oddNumbers.take(5).toList())
    //println(oddNumbers.count())     // error: the sequence is infinite
}

generateSequence()で有限シーケンスを作成するには、必要な最後の要素の後にnullを返す関数を提供します。

fun main() {
    val oddNumbersLessThan10 = generateSequence(1) { if (it < 8) it + 2 else null }
    println(oddNumbersLessThan10.count())
}

チャンクから

最後に、シーケンス要素を1つずつ、または任意のサイズのチャンクで生成できる関数sequence()があります。 この関数は、yield()およびyieldAll()関数の呼び出しを含むラムダ式を受け取ります。 これらはシーケンスのコンシューマに要素を返し、コンシューマが次の要素を要求するまでsequence()の実行を中断します。yield()は単一の要素を引数として受け取ります。yieldAll()はIterableオブジェクト、Iterator、または別のSequenceを受け取ることができます。yieldAll()のSequence引数は無限である可能性があります。ただし、そのような呼び出しは最後である必要があります。それ以降の呼び出しは実行されません。

fun main() {
    val oddNumbers = sequence {
        yield(1)
        yieldAll(listOf(3, 5))
        yieldAll(generateSequence(7) { it + 2 })
    }
    println(oddNumbers.take(5).toList())
}

シーケンス操作

シーケンス操作は、その状態要件に関して以下のグループに分類できます。

• _ステートレス_操作は状態を必要とせず、各要素を独立して処理します。例えば、map()やfilter()などです。 ステートレス操作は、要素を処理するために少量の定数状態を必要とすることもあります。例えば、take()またはdrop()などです。
• _ステートフル_操作は、通常、シーケンス内の要素数に比例する、かなりの量の状態を必要とします。

シーケンス操作が別のシーケンスを返し、それが遅延して生成される場合、それは_中間_操作と呼ばれます。 それ以外の場合、その操作は_終端_操作です。終端操作の例としては、toList()やsum()などがあります。シーケンス要素は、終端操作によってのみ取得できます。

シーケンスは複数回イテレートできますが、一部のシーケンス実装では1回のみのイテレーションに制限される場合があります。それはそれぞれのドキュメントに具体的に記載されています。

シーケンス処理の例

IterableとSequenceの違いを例で見てみましょう。

Iterable

単語のリストがあると仮定します。以下のコードは、3文字より長い単語をフィルタリングし、そのような最初の4つの単語の長さを出力します。

fun main() {    
    val words = "The quick brown fox jumps over the lazy dog".split(" ")
    val lengthsList = words.filter { println("filter: $it"); it.length > 3 }
        .map { println("length: ${it.length}"); it.length }
        .take(4)

    println("Lengths of first 4 words longer than 3 chars:")
    println(lengthsList)
}

このコードを実行すると、filter()とmap()関数がコードに現れるのと同じ順序で実行されることがわかります。まず、すべての要素に対してfilter:が表示され、次にフィルタリング後に残った要素に対してlength:が表示され、最後に残りの2行の出力が表示されます。

リスト処理は以下のようになります。

シーケンス

では、同じことをシーケンスで記述してみましょう。

fun main() {
    val words = "The quick brown fox jumps over the lazy dog".split(" ")
    //convert the List to a Sequence
    val wordsSequence = words.asSequence()

    val lengthsSequence = wordsSequence.filter { println("filter: $it"); it.length > 3 }
        .map { println("length: ${it.length}"); it.length }
        .take(4)

    println("Lengths of first 4 words longer than 3 chars")
    // terminal operation: obtaining the result as a List
    println(lengthsSequence.toList())
}

このコードの出力は、filter()とmap()関数が結果リストを構築する際にのみ呼び出されることを示しています。 したがって、最初にテキスト行"Lengths of.."が表示され、その後にシーケンス処理が開始されます。 フィルタリング後に残った要素の場合、次の要素をフィルタリングする前にmapが実行されることに注意してください。 結果のサイズが4に達すると、take(4)が返すことができる最大のサイズであるため、処理は停止します。

シーケンス処理は以下のようになります。

この例では、要素の遅延処理と4つの項目を見つけた後の停止により、リストアプローチを使用した場合と比較して操作の数が削減されます。