Enumerable.ToLookup Method

Definition

Namespace:: System.Linq

Assemblies:: System.Core.dll, System.Linq.dll

Assemblies:: netstandard.dll, System.Linq.dll

Assembly:: System.Linq.dll

Assembly:: System.Core.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a generic Lookup from an IEnumerable.

Overloads

Name	Description
ToLookup(IEnumerable, Func, Func)	Creates a Lookup from an IEnumerable according to specified key selector and element selector functions.
ToLookup(IEnumerable, Func, Func, IEqualityComparer)	Creates a Lookup from an IEnumerable according to a specified key selector function, a comparer and an element selector function.
ToLookup(IEnumerable, Func)	Creates a Lookup from an IEnumerable according to a specified key selector function.
ToLookup(IEnumerable, Func, IEqualityComparer)	Creates a Lookup from an IEnumerable according to a specified key selector function and key comparer.

ToLookup(IEnumerable, Func, Func)

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Creates a Lookup from an IEnumerable according to specified key selector and element selector functions.

public:
generic 
[System::Runtime::CompilerServices::Extension]
 static System::Linq::ILookup ^ ToLookup(System::Collections::Generic::IEnumerable ^ source, Func ^ keySelector, Func ^ elementSelector);

public static System.Linq.ILookup ToLookup(this System.Collections.Generic.IEnumerable source, Func keySelector, Func elementSelector);

static member ToLookup : seq<'Source> * Func<'Source, 'Key> * Func<'Source, 'Element> -> System.Linq.ILookup<'Key, 'Element>


Public Function ToLookup(Of TSource, TKey, TElement) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), elementSelector As Func(Of TSource, TElement)) As ILookup(Of TKey, TElement)

Type Parameters

TSource

The type of the elements of source.

TKey

The type of the key returned by keySelector.

TElement

The type of the value returned by elementSelector.

Parameters

source: IEnumerable

The IEnumerable to create a Lookup from.

keySelector: Func

A function to extract a key from each element.

elementSelector: Func

A transform function to produce a result element value from each element.

Returns

ILookup

A Lookup that contains values of type TElement selected from the input sequence.

Exceptions

ArgumentNullException

source or keySelector or elementSelector is null.

Examples

The following code example demonstrates how to use ToLookup(IEnumerable, Func, Func) to create a Lookup by using a key selector function and an element selector function.

class Package
{
    public string Company { get; set; }
    public double Weight { get; set; }
    public long TrackingNumber { get; set; }
}

public static void ToLookupEx1()
{
    // Create a list of Packages.
    List packages =
        new List
            { new Package { Company = "Coho Vineyard",
                  Weight = 25.2, TrackingNumber = 89453312L },
              new Package { Company = "Lucerne Publishing",
                  Weight = 18.7, TrackingNumber = 89112755L },
              new Package { Company = "Wingtip Toys",
                  Weight = 6.0, TrackingNumber = 299456122L },
              new Package { Company = "Contoso Pharmaceuticals",
                  Weight = 9.3, TrackingNumber = 670053128L },
              new Package { Company = "Wide World Importers",
                  Weight = 33.8, TrackingNumber = 4665518773L } };

    // Create a Lookup to organize the packages.
    // Use the first character of Company as the key value.
    // Select Company appended to TrackingNumber
    // as the element values of the Lookup.
    ILookup lookup =
        packages
        .ToLookup(p => p.Company[0],
                  p => p.Company + " " + p.TrackingNumber);

    // Iterate through each IGrouping in the Lookup.
    foreach (IGrouping packageGroup in lookup)
    {
        // Print the key value of the IGrouping.
        Console.WriteLine(packageGroup.Key);
        // Iterate through each value in the
        // IGrouping and print its value.
        foreach (string str in packageGroup)
            Console.WriteLine("    {0}", str);
    }
}

/*
 This code produces the following output:

 C
     Coho Vineyard 89453312
     Contoso Pharmaceuticals 670053128
 L
     Lucerne Publishing 89112755
 W
     Wingtip Toys 299456122
     Wide World Importers 4665518773
*/

Structure Package
    Public Company As String
    Public Weight As Double
    Public TrackingNumber As Long
End Structure

Sub ToLookupEx1()
    ' Create a list of Packages.
    Dim packages As New List(Of Package)(New Package() _
     {New Package With
      {.Company = "Coho Vineyard", .Weight = 25.2, .TrackingNumber = 89453312L},
      New Package With
      {.Company = "Lucerne Publishing", .Weight = 18.7, .TrackingNumber = 89112755L},
      New Package With
      {.Company = "Wingtip Toys", .Weight = 6.0, .TrackingNumber = 299456122L},
      New Package With
      {.Company = "Contoso Pharmaceuticals", .Weight = 9.3, .TrackingNumber = 670053128L},
      New Package With
      {.Company = "Wide World Importers", .Weight = 33.8, .TrackingNumber = 4665518773L}})

    ' Create a Lookup to organize the packages.
    ' Use the first character of Company as the key value.
    ' Select Company appended to TrackingNumber
    ' as the element values of the Lookup.
    Dim lookup As ILookup(Of Char, String) =
    packages.ToLookup(Function(p) _
                          Convert.ToChar(p.Company.Substring(0, 1)),
                      Function(p) _
                          p.Company & " " & p.TrackingNumber)

    Dim output As New System.Text.StringBuilder

    ' Iterate through each IGrouping in the Lookup.
    For Each packageGroup As IGrouping(Of Char, String) In lookup
        ' Print the key value of the IGrouping.
        output.AppendLine(packageGroup.Key)
        ' Iterate through each value in the IGrouping and print its value.
        For Each str As String In packageGroup
            output.AppendLine("   " & str)
        Next
    Next

    ' Select a group of packages by indexing directly into the Lookup.
    Dim cgroup As IEnumerable(Of String) = lookup("C"c)

    output.AppendLine(vbCrLf & "Packages from Company names that start with 'C':")
    For Each str As String In cgroup
        output.AppendLine(str)
    Next

    ' Display the output.
    Console.WriteLine(output.ToString())
End Sub

' This code produces the following output:
'
' C
'    Coho Vineyard 89453312
'    Contoso Pharmaceuticals 670053128
' L
'    Lucerne Publishing 89112755
' W
'    Wingtip Toys 299456122
'    Wide World Importers 4665518773
'
' Packages from Company names that start with 'C':
' Coho Vineyard 89453312
' Contoso Pharmaceuticals 670053128

Remarks

The ToLookup(IEnumerable, Func, Func) method returns a Lookup, a one-to-many dictionary that maps keys to collections of values. A Lookup differs from a Dictionary, which performs a one-to-one mapping of keys to single values.

The default equality comparer Default is used to compare keys.

Applies to

ToLookup(IEnumerable, Func, Func, IEqualityComparer)

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Creates a Lookup from an IEnumerable according to a specified key selector function, a comparer and an element selector function.

public:
generic 
[System::Runtime::CompilerServices::Extension]
 static System::Linq::ILookup ^ ToLookup(System::Collections::Generic::IEnumerable ^ source, Func ^ keySelector, Func ^ elementSelector, System::Collections::Generic::IEqualityComparer ^ comparer);

public static System.Linq.ILookup ToLookup(this System.Collections.Generic.IEnumerable source, Func keySelector, Func elementSelector, System.Collections.Generic.IEqualityComparer comparer);

public static System.Linq.ILookup ToLookup(this System.Collections.Generic.IEnumerable source, Func keySelector, Func elementSelector, System.Collections.Generic.IEqualityComparer? comparer);

static member ToLookup : seq<'Source> * Func<'Source, 'Key> * Func<'Source, 'Element> * System.Collections.Generic.IEqualityComparer<'Key> -> System.Linq.ILookup<'Key, 'Element>


Public Function ToLookup(Of TSource, TKey, TElement) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), elementSelector As Func(Of TSource, TElement), comparer As IEqualityComparer(Of TKey)) As ILookup(Of TKey, TElement)

Type Parameters

TSource

The type of the elements of source.

TKey

The type of the key returned by keySelector.

TElement

The type of the value returned by elementSelector.

Parameters

source: IEnumerable

The IEnumerable to create a Lookup from.

keySelector: Func

A function to extract a key from each element.

elementSelector: Func

A transform function to produce a result element value from each element.

comparer: IEqualityComparer

An IEqualityComparer to compare keys.

Returns

ILookup

A Lookup that contains values of type TElement selected from the input sequence.

Exceptions

ArgumentNullException

source or keySelector or elementSelector is null.

Remarks

The ToLookup(IEnumerable, Func, Func, IEqualityComparer) method returns a Lookup, a one-to-many dictionary that maps keys to collections of values. A Lookup differs from a Dictionary, which performs a one-to-one mapping of keys to single values.

If comparer is null, the default equality comparer Default is used to compare keys.

Applies to

ToLookup(IEnumerable, Func)

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Creates a Lookup from an IEnumerable according to a specified key selector function.

public:
generic 
[System::Runtime::CompilerServices::Extension]
 static System::Linq::ILookup ^ ToLookup(System::Collections::Generic::IEnumerable ^ source, Func ^ keySelector);

public static System.Linq.ILookup ToLookup(this System.Collections.Generic.IEnumerable source, Func keySelector);

static member ToLookup : seq<'Source> * Func<'Source, 'Key> -> System.Linq.ILookup<'Key, 'Source>


Public Function ToLookup(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey)) As ILookup(Of TKey, TSource)

Type Parameters

TSource

The type of the elements of source.

TKey

The type of the key returned by keySelector.

Parameters

source: IEnumerable

The IEnumerable to create a Lookup from.

keySelector: Func

A function to extract a key from each element.

Returns

ILookup

A Lookup that contains keys and values. The values within each group are in the same order as in source.

Exceptions

ArgumentNullException

source or keySelector is null.

Remarks

The ToLookup(IEnumerable, Func) method returns a Lookup, a one-to-many dictionary that maps keys to collections of values. A Lookup differs from a Dictionary, which performs a one-to-one mapping of keys to single values.

The default equality comparer Default is used to compare keys.

Applies to

ToLookup(IEnumerable, Func, IEqualityComparer)

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Source:: Lookup.cs

Creates a Lookup from an IEnumerable according to a specified key selector function and key comparer.

public:
generic 
[System::Runtime::CompilerServices::Extension]
 static System::Linq::ILookup ^ ToLookup(System::Collections::Generic::IEnumerable ^ source, Func ^ keySelector, System::Collections::Generic::IEqualityComparer ^ comparer);

public static System.Linq.ILookup ToLookup(this System.Collections.Generic.IEnumerable source, Func keySelector, System.Collections.Generic.IEqualityComparer comparer);

public static System.Linq.ILookup ToLookup(this System.Collections.Generic.IEnumerable source, Func keySelector, System.Collections.Generic.IEqualityComparer? comparer);

static member ToLookup : seq<'Source> * Func<'Source, 'Key> * System.Collections.Generic.IEqualityComparer<'Key> -> System.Linq.ILookup<'Key, 'Source>


Public Function ToLookup(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), comparer As IEqualityComparer(Of TKey)) As ILookup(Of TKey, TSource)

Type Parameters

TSource

The type of the elements of source.

TKey

The type of the key returned by keySelector.

Parameters

source: IEnumerable

The IEnumerable to create a Lookup from.

keySelector: Func

A function to extract a key from each element.

comparer: IEqualityComparer

An IEqualityComparer to compare keys.

Returns

ILookup

A Lookup that contains keys and values. The values within each group are in the same order as in source.

Exceptions

ArgumentNullException

source or keySelector is null.

Remarks

The ToLookup(IEnumerable, Func, IEqualityComparer) method returns a Lookup, a one-to-many dictionary that maps keys to collections of values. A Lookup is different to a Dictionary, which performs a one-to-one mapping of keys to single values.

If comparer is null, the default equality comparer Default is used to compare keys.

Applies to

Feedback

Was this page helpful?