CapyKit/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md
Jordan Wages 735d7c4c91 Documentation + Unfinished SecurityHelper
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
2024-04-19 23:12:24 -05:00

4.4 KiB

LeftOuterJoin<T, U, TKey, R>(IEnumerable<T>, IEnumerable<U>, Func<T, TKey>, Func<U, TKey>, Func<T, IEnumerable<U>, R>, Func<T, U>) Method

An IEnumable<T> extension method that left outer join.

Definition

Namespace: CapyKit.Extensions
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d

C#

public static IEnumerable<R> LeftOuterJoin<T, U, TKey, R>(
	this IEnumerable<T> source,
	IEnumerable<U> inner,
	Func<T, TKey> outerSelector,
	Func<U, TKey> innerSelector,
	Func<T, IEnumerable<U>, R> resultSelector,
	Func<T, U> defaultGenerator = null
)

VB

<ExtensionAttribute>
Public Shared Function LeftOuterJoin(Of T, U, TKey, R) ( 
	source As IEnumerable(Of T),
	inner As IEnumerable(Of U),
	outerSelector As Func(Of T, TKey),
	innerSelector As Func(Of U, TKey),
	resultSelector As Func(Of T, IEnumerable(Of U), R),
	Optional defaultGenerator As Func(Of T, U) = Nothing
) As IEnumerable(Of R)

C++

public:
[ExtensionAttribute]
generic<typename T, typename U, typename TKey, typename R>
static IEnumerable<R>^ LeftOuterJoin(
	IEnumerable<T>^ source, 
	IEnumerable<U>^ inner, 
	Func<T, TKey>^ outerSelector, 
	Func<U, TKey>^ innerSelector, 
	Func<T, IEnumerable<U>^, R>^ resultSelector, 
	Func<T, U>^ defaultGenerator = nullptr
)

F#

[<ExtensionAttribute>]
static member LeftOuterJoin : 
        source : IEnumerable<'T> * 
        inner : IEnumerable<'U> * 
        outerSelector : Func<'T, 'TKey> * 
        innerSelector : Func<'U, 'TKey> * 
        resultSelector : Func<'T, IEnumerable<'U>, 'R> * 
        ?defaultGenerator : Func<'T, 'U> 
(* Defaults:
        let _defaultGenerator = defaultArg defaultGenerator null
*)
-> IEnumerable<'R> 

Parameters

  IEnumerable(T)
The source to act on.
  IEnumerable(U)
The inner.
  Func(T, TKey)
The outer selector.
  Func(U, TKey)
The inner selector.
  Func(T, IEnumerable(U), R)
The result selector.
  Func(T, U)  (Optional)
(Optional) The default generator.

Type Parameters

Generic type parameter.
Generic type parameter.
Type of the key.
Type of the r.

Return Value

IEnumerable(R)
An enumerator that allows foreach to be used to process left outter join in this collection.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see

Extension Methods (Visual Basic) or

Extension Methods (C# Programming Guide).

See Also

Reference

LINQExtensions Class
LeftOuterJoin Overload
CapyKit.Extensions Namespace