Aggregate 句 (Visual Basic)Aggregate Clause (Visual Basic)

1 つ以上の集計関数をコレクションに適用します。Applies one or more aggregate functions to a collection.

構文Syntax

Aggregate element [As type] In collection _  
  [, element2 [As type2] In collection2, [...]]  
  [ clause ]  
  Into expressionList  

指定項目Parts

用語Term 定義Definition
element 必須です。Required. コレクションの要素の反復処理に使用される変数。Variable used to iterate through the elements of the collection.
type 任意。Optional. element の型。The type of element. 型が指定されていない場合、element の型は collection から推論されます。If no type is specified, the type of element is inferred from collection.
collection 必須です。Required. 操作対象のコレクションを参照します。Refers to the collection to operate on.
clause 任意。Optional. Aggregate 句を適用するクエリ結果を絞り込むための Where 句などの 1 つ以上のクエリ句。One or more query clauses, such as a Where clause, to refine the query result to apply the aggregate clause or clauses to.
expressionList 必須です。Required. コレクションに適用する集計関数を識別する 1 つ以上のコンマ区切り式。One or more comma-delimited expressions that identify an aggregate function to apply to the collection. 集計関数に別名を適用して、クエリ結果のメンバー名を指定できます。You can apply an alias to an aggregate function to specify a member name for the query result. 別名が指定されていない場合、集計関数の名前が使用されます。If no alias is supplied, the name of the aggregate function is used. 例については、このトピックで後述する集計関数に関するセクションを参照してください。For examples, see the section about aggregate functions later in this topic.

RemarksRemarks

Aggregate 句を使用して、クエリに集計関数を含めることができます。The Aggregate clause can be used to include aggregate functions in your queries. 集計関数は、値の集まりに対して、チェックと計算を実行し、1 つの値を返します。Aggregate functions perform checks and computations over a set of values and return a single value. クエリ結果の型のメンバーを使用して、計算された値にアクセスできます。You can access the computed value by using a member of the query result type. 使用できる標準の集計関数は、AllAnyAverageCountLongCountMaxMinSum 関数です。The standard aggregate functions that you can use are the All, Any, Average, Count, LongCount, Max, Min, and Sum functions. これらの関数は、SQL での集計に精通している開発者になじみがあります。These functions are familiar to developers who are familiar with aggregates in SQL. このトピックの以降のセクションで、それらについて説明します。They are described in the following section of this topic.

集計関数の結果は、クエリ結果の型のフィールドとしてクエリ結果に含まれます。The result of an aggregate function is included in the query result as a field of the query result type. 集計関数の結果に別名を指定して、集計値を保持するクエリ結果の型のメンバーの名前を指定できます。You can supply an alias for the aggregate function result to specify the name of the member of the query result type that will hold the aggregate value. 別名が指定されていない場合、集計関数の名前が使用されます。If no alias is supplied, the name of the aggregate function is used.

Aggregate 句は、クエリを開始したり、クエリの追加の句として含めたりすることができます。The Aggregate clause can begin a query, or it can be included as an additional clause in a query. Aggregate 句によってクエリが開始された場合、結果は、Into 句に指定された集計関数の結果である単一の値になります。If the Aggregate clause begins a query, the result is a single value that is the result of the aggregate function specified in the Into clause. Into 句に複数の集計関数が指定されている場合、クエリでは、Into 句で各集計関数の結果を参照するための個別のプロパティを持つ単一の型が返されます。If more than one aggregate function is specified in the Into clause, the query returns a single type with a separate property to reference the result of each aggregate function in the Into clause. Aggregate 句がクエリに追加の句として含まれている場合、クエリ コレクションで返される型には、Into 句で各集計関数の結果を参照する個別のプロパティがあります。If the Aggregate clause is included as an additional clause in a query, the type returned in the query collection will have a separate property to reference the result of each aggregate function in the Into clause.

集計関数Aggregate Functions

次に、Aggregate 句で使用できる標準の集計関数を示します。The following are the standard aggregate functions that can be used with the Aggregate clause.

すべてAll

コレクション内のすべての要素が指定された条件を満たす場合に true を返します。それ以外の場合は false を返します。Returns true if all elements in the collection satisfy a specified condition; otherwise returns false. 次に例を示します。The following is an example:

Dim customerList1 = Aggregate order In orders
                    Into AllOrdersOver100 = All(order.Total >= 100)

どれでも可Any

コレクション内のいずれかの要素が指定された条件を満たす場合に true を返します。それ以外の場合は false を返します。Returns true if any element in the collection satisfies a specified condition; otherwise returns false. 次に例を示します。The following is an example:

Dim customerList2 = From cust In customers
                    Aggregate order In cust.Orders
                    Into AnyOrderOver500 = Any(order.Total >= 500)

平均Average

コレクション内のすべての要素の平均値を計算するか、コレクション内のすべての要素に対して指定された式を計算します。Computes the average of all elements in the collection, or computes a supplied expression for all elements in the collection. 次に例を示します。The following is an example:

Dim customerOrderAverage = Aggregate order In orders
                           Into Average(order.Total)

カウントCount

コレクション内の要素の数をカウントします。Counts the number of elements in the collection. 条件を満たすコレクション内の要素の数のみをカウントする省略可能な Boolean 式を指定できます。You can supply an optional Boolean expression to count only the number of elements in the collection that satisfy a condition. 次に例を示します。The following is an example:

Dim customerOrderAfter1996 = From cust In customers
                             Aggregate order In cust.Orders
                             Into Count(order.OrderDate > #12/31/1996#)

グループ化Group

Group By または Group Join 句の結果として、グループ化されたクエリ結果を参照します。Refers to query results that are grouped as a result of a Group By or Group Join clause. Group 関数は、Group By または Group Join 句の Into 句でのみ有効です。The Group function is valid only in the Into clause of a Group By or Group Join clause. 詳細と例については、「Group By 句」と「Group Join 句」を参照してください。For more information and examples, see Group By Clause and Group Join Clause.

LongCountLongCount

コレクション内の要素の数をカウントします。Counts the number of elements in the collection. 条件を満たすコレクション内の要素の数のみをカウントする省略可能な Boolean 式を指定できます。You can supply an optional Boolean expression to count only the number of elements in the collection that satisfy a condition. 結果を Long として返します。Returns the result as a Long. 例については、「Count 集計関数」を参照してください。For an example, see the Count aggregate function.

最大Max

コレクションから最大値を計算するか、コレクション内のすべての要素に対して指定された式を計算します。Computes the maximum value from the collection, or computes a supplied expression for all elements in the collection. 次に例を示します。The following is an example:

Dim customerMaxOrder = Aggregate order In orders
                       Into MaxOrder = Max(order.Total)

最小Min

コレクションから最小値を計算するか、コレクション内のすべての要素に対して指定された式を計算します。Computes the minimum value from the collection, or computes a supplied expression for all elements in the collection. 次に例を示します。The following is an example:

Dim customerMinOrder = From cust In customers
                       Aggregate order In cust.Orders
                       Into MinOrder = Min(order.Total)

SumSum

コレクション内のすべての要素の合計を計算するか、コレクション内のすべての要素に対して指定された式を計算します。Computes the sum of all elements in the collection, or computes a supplied expression for all elements in the collection. 次に例を示します。The following is an example:

Dim customerTotals = From cust In customers
                     Aggregate order In cust.Orders
                     Into Sum(order.Total)

Example

次の例では、Aggregate 句を使用して、クエリ結果に集計関数を適用する方法を示します。The following example shows how to use the Aggregate clause to apply aggregate functions to a query result.

Public Sub AggregateSample()
    Dim customers = GetCustomerList()

    Dim customerOrderTotal =
        From cust In customers
        Aggregate order In cust.Orders
        Into Sum(order.Total), MaxOrder = Max(order.Total),
        MinOrder = Min(order.Total), Avg = Average(order.Total)

    For Each customer In customerOrderTotal
        Console.WriteLine(customer.cust.CompanyName & vbCrLf &
                         vbTab & "Sum = " & customer.Sum & vbCrLf &
                         vbTab & "Min = " & customer.MinOrder & vbCrLf &
                         vbTab & "Max = " & customer.MaxOrder & vbCrLf &
                         vbTab & "Avg = " & customer.Avg.ToString("#.##"))
    Next
End Sub

ユーザー定義集計関数の作成Creating User-Defined Aggregate Functions

IEnumerable<T> 型に拡張メソッドを追加することで、独自のカスタム集計関数をクエリ式に含めることができます。You can include your own custom aggregate functions in a query expression by adding extension methods to the IEnumerable<T> type. カスタム メソッドが、集計関数を参照した列挙可能なコレクションに対して計算や操作を実行できるようになります。Your custom method can then perform a calculation or operation on the enumerable collection that has referenced your aggregate function. 拡張メソッドについて詳しくは、「拡張メソッド」をご覧ください。For more information about extension methods, see Extension Methods.

たとえば、次の例では、数値のコレクションの中央値を計算するカスタム集計関数を示しています。For example, the following example shows a custom aggregate function that calculates the median value of a collection of numbers. Median 拡張メソッドには、2 つのオーバーロードがあります。There are two overloads of the Median extension method. 最初のオーバーロードでは、入力として IEnumerable(Of Double) 型のコレクションを受け入れます。The first overload accepts, as input, a collection of type IEnumerable(Of Double). Double 型のクエリ フィールドに対して Median 集計関数が呼び出されると、このメソッドが呼び出されます。If the Median aggregate function is called for a query field of type Double, this method will be called. Median メソッドの 2 つ目のオーバーロードには、任意のジェネリック型を渡すことができます。The second overload of the Median method can be passed any generic type. Median メソッドのジェネリック オーバーロードは、Func(Of T, Double) ラムダ式を参照する 2 つ目のパラメーターを受け取ります。このパラメーターは、ある型 (コレクションからの) の値を Double 型の対応する値としてプロジェクションします。The generic overload of the Median method takes a second parameter that references the Func(Of T, Double) lambda expression to project a value for a type (from a collection) as the corresponding value of type Double. 次に、中央値の計算を Median メソッドの他のオーバーロードにデリゲートします。It then delegates the calculation of the median value to the other overload of the Median method. ラムダ式について詳しくは、「ラムダ式」をご覧ください。For more information about lambda expressions, see Lambda Expressions.

Imports System.Runtime.CompilerServices

Module UserDefinedAggregates

    ' Calculate the median value for a collection of type Double.
    <Extension()>
    Function Median(ByVal values As IEnumerable(Of Double)) As Double
        If values.Count = 0 Then
            Throw New InvalidOperationException("Cannot compute median for an empty set.")
        End If

        Dim sortedList = From number In values
                         Order By number

        Dim medianValue As Double

        Dim itemIndex = CInt(Int(sortedList.Count / 2))

        If sortedList.Count Mod 2 = 0 Then
            ' Even number of items in list.
            medianValue = ((sortedList(itemIndex) + sortedList(itemIndex - 1)) / 2)
        Else
            ' Odd number of items in list.
            medianValue = sortedList(itemIndex)
        End If

        Return medianValue
    End Function

    ' "Cast" the collection of generic items as type Double and call the 
    ' Median() method to calculate the median value.
    <Extension()>
    Function Median(Of T)(ByVal values As IEnumerable(Of T),
                          ByVal selector As Func(Of T, Double)) As Double
        Return (From element In values Select selector(element)).Median()
    End Function

End Module

次の例は、Integer 型のコレクションと Double 型のコレクションに対して Median 集計関数を呼び出すサンプル クエリを示しています。The following example shows sample queries that call the Median aggregate function on a collection of type Integer, and a collection of type Double. Double 型のコレクションに対して Median 集計関数を呼び出すクエリは、Double 型のコレクションを入力として受け入れる Median メソッドのオーバーロードを呼び出します。The query that calls the Median aggregate function on the collection of type Double calls the overload of the Median method that accepts, as input, a collection of type Double. Integer 型のコレクションに対して Median 集計関数を呼び出すクエリは、Median メソッドのジェネリック オーバーロードを呼び出します。The query that calls the Median aggregate function on the collection of type Integer calls the generic overload of the Median method.

Module Module1

    Sub Main()
        Dim numbers1 = {1, 2, 3, 4, 5}

        Dim query1 = Aggregate num In numbers1 Into Median(num)

        Console.WriteLine("Median = " & query1)

        Dim numbers2 = {1.9, 2, 8, 4, 5.7, 6, 7.2, 0}

        Dim query2 = Aggregate num In numbers2 Into Median()

        Console.WriteLine("Median = " & query2)
    End Sub

End Module

関連項目See also