Enumerable.GroupBy<TSource, TKey, TElement> (Método) (IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>)

public static IEnumerable<IGrouping<TKey, TElement>> GroupBy<TSource, TKey, TElement>(
	this IEnumerable<TSource> source,
	Func<TSource, TKey> keySelector,
	Func<TSource, TElement> elementSelector
)

Nota sobre el uso

Este método se implementa usando la ejecución diferida. El valor devuelto inmediato es un objeto que almacena toda la información necesaria para realizar la acción. La consulta representada por este método no se ejecuta hasta que se enumera el objeto mediante una llamada directa a su método GetEnumerator o a través de foreach en Visual C# o For Each en Visual Basic.

El método GroupBy<TSource, TKey, TElement>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>) devuelve una colección de objetos IGrouping<TKey, TElement>, uno por cada una de las distintas claves encontradas. IGrouping<TKey, TElement> es una interfaz IEnumerable<T> que también tiene una clave asociada a sus elementos.

Los objetos IGrouping<TKey, TElement> se proporcionan en un orden que se establece de acuerdo con el orden que siguen los elementos en el parámetro source que produjo la primera clave de cada IGrouping<TKey, TElement>. Los elementos de una agrupación se proporcionan en el mismo orden que mantienen en source los elementos que los generan.

El comparador de igualdad predeterminado Default se utiliza para comparar claves.

En el ejemplo de código siguiente se muestra cómo utilizar GroupBy<TSource, TKey, TElement>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>) para agrupar los elementos de una secuencia.

            class Pet
            {
                public string Name { get; set; }
                public int Age { get; set; }
            }

            // Uses method-based query syntax.
            public static void GroupByEx1()
            {
                // Create a list of pets.
                List<Pet> pets =
                    new List<Pet>{ new Pet { Name="Barley", Age=8 },
                                   new Pet { Name="Boots", Age=4 },
                                   new Pet { Name="Whiskers", Age=1 },
                                   new Pet { Name="Daisy", Age=4 } };

                // Group the pets using Age as the key value 
                // and selecting only the pet's Name for each value.
                IEnumerable<IGrouping<int, string>> query =
                    pets.GroupBy(pet => pet.Age, pet => pet.Name);

                // Iterate over each IGrouping in the collection.
                foreach (IGrouping<int, string> petGroup in query)
                {
                    // Print the key value of the IGrouping.
                    Console.WriteLine(petGroup.Key);
                    // Iterate over each value in the 
                    // IGrouping and print the value.
                    foreach (string name in petGroup)
                        Console.WriteLine("  {0}", name);
                }
            }

            /*
             This code produces the following output:

             8
               Barley
             4
               Boots
               Daisy
             1
               Whiskers
            */

En la sintaxis de las expresiones de consulta, una cláusula group by (Visual C#) o Group By Into (Visual Basic) se convierte en una invocación de GroupBy. La conversión de la expresión de consulta en el ejemplo siguiente es equivalente a la consulta del ejemplo anterior.

IEnumerable<IGrouping<int, string>> query =
    from pet in pets
    group pet.Name by pet.Age;

Nota
En una expresión de consulta de Visual C# o Visual Basic, las expresiones de selección de elementos y claves se producen en orden inverso a la posición que tienen sus argumentos en una llamada al método GroupBy<TSource, TKey, TElement>(IEnumerable<TSource>, Func<TSource, TKey>, Func<TSource, TElement>).

.NET Framework

.NET Framework Client Profile

Biblioteca de clases portable

.NET para aplicaciones de la Tienda Windows

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (no se admite el rol Server Core), Windows Server 2008 R2 (se admite el rol Server Core con SP1 o versiones posteriores; no se admite Itanium)

Referencia

Otros recursos