反復子 (Visual Basic)

  • [アーティクル]

関数または Get アクセサーが反復子であることを示します。

Remarks

反復子は、コレクションに対するカスタム イテレーションを実行します。 反復子は、Yield ステートメントを使用して、コレクションの各要素を 1 回に 1 つ返します。 Yield ステートメントに達すると、コードの現在の場所が保持されます。 次回、Iterator 関数が呼び出されると、この位置から実行が再開されます。

反復子は、関数として実装することも、プロパティ定義の Get アクセサーとして実装することもできます。 Iterator 修飾子は、Iterator 関数または Get アクセサーの宣言に記述されます。

For Each...Next ステートメントを使用して、クライアント コードから反復子を呼び出します。

Iterator 関数または Get アクセサーの戻り値の型は、IEnumerable、IEnumerable<T>、IEnumerator、または IEnumerator<T> となります。

反復子に ByRef パラメーターを指定することはできません。

反復子を、イベント、インスタンス コンストラクター、静的コンストラクター、静的デストラクターで指定することはできません。

反復子は、匿名関数にすることができます。 詳細については、「 反復子」を参照してください。

使用方法

Iterator 修飾子は、次のコンテキストで使用できます。

例 1

次の例では、Iterator 関数を示します。 Iterator 関数には、For…Next ループ内に Yield ステートメントがあります。 Main 内の For Each ステートメント本体の各反復処理では、Power Iterator 関数が呼び出されます。 Iterator 関数を呼び出すごとに、Yield ステートメントの次の実行に進みます。これは、For…Next ループの次の反復処理で行われます。

Sub Main()
    For Each number In Power(2, 8)
        Console.Write(number & " ")
    Next
    ' Output: 2 4 8 16 32 64 128 256
    Console.ReadKey()
End Sub

Private Iterator Function Power(
ByVal base As Integer, ByVal highExponent As Integer) _
As System.Collections.Generic.IEnumerable(Of Integer)

    Dim result = 1

    For counter = 1 To highExponent
        result = result * base
        Yield result
    Next
End Function

例 2

次の例は、反復子である Get アクセサーを示しています。 Iterator 修飾子は、プロパティ宣言にあります。

Sub Main()
    Dim theGalaxies As New Galaxies
    For Each theGalaxy In theGalaxies.NextGalaxy
        With theGalaxy
            Console.WriteLine(.Name & "  " & .MegaLightYears)
        End With
    Next
    Console.ReadKey()
End Sub

Public Class Galaxies
    Public ReadOnly Iterator Property NextGalaxy _
    As System.Collections.Generic.IEnumerable(Of Galaxy)
        Get
            Yield New Galaxy With {.Name = "Tadpole", .MegaLightYears = 400}
            Yield New Galaxy With {.Name = "Pinwheel", .MegaLightYears = 25}
            Yield New Galaxy With {.Name = "Milky Way", .MegaLightYears = 0}
            Yield New Galaxy With {.Name = "Andromeda", .MegaLightYears = 3}
        End Get
    End Property
End Class

Public Class Galaxy
    Public Property Name As String
    Public Property MegaLightYears As Integer
End Class

その他の例については、「反復子」を参照してください。

関連項目