LeadExtension.Lead<TSource, TResult>(IEnumerable<TSource>, Int32, TSource, Func<TSource, TSource, TResult>) Method

Produces a projection of a sequence by evaluating pairs of elements separated by a positive offset.

Definition

Namespace: MoreLinq.Extensions
Assembly: MoreLinq (in MoreLinq.dll) Version: 4.0.0+092a40d82a1b280568ffa006d9a210bdec0792cd

C#
public static IEnumerable<TResult> Lead<TSource, TResult>(
	this IEnumerable<TSource> source,
	int offset,
	TSource defaultLeadValue,
	Func<TSource, TSource, TResult> resultSelector
)

VB
<ExtensionAttribute>
Public Shared Function Lead(Of TSource, TResult) ( 
	source As IEnumerable(Of TSource),
	offset As Integer,
	defaultLeadValue As TSource,
	resultSelector As Func(Of TSource, TSource, TResult)
) As IEnumerable(Of TResult)

C++
public:
[ExtensionAttribute]
generic<typename TSource, typename TResult>
static IEnumerable<TResult>^ Lead(
	IEnumerable<TSource>^ source, 
	int offset, 
	TSource defaultLeadValue, 
	Func<TSource, TSource, TResult>^ resultSelector
)

F#
[<ExtensionAttribute>]
static member Lead : 
        source : IEnumerable<'TSource> * 
        offset : int * 
        defaultLeadValue : 'TSource * 
        resultSelector : Func<'TSource, 'TSource, 'TResult> -> IEnumerable<'TResult> 

Parameters

source IEnumerable<TSource>: The sequence over which to evaluate Lead.
offset Int32: The offset (expressed as a positive number) by which to lead each element of the sequence.
defaultLeadValue TSource: A default value supplied for the leading element when none is available.
resultSelector Func<TSource, TSource, TResult>: A projection function which accepts the current and subsequent (lead) element (in that order) and produces a result.

Type Parameters

TSource: The type of the elements in the source sequence.
TResult: The type of the elements in the result sequence.

Return Value

IEnumerable<TResult>
A sequence produced by projecting each element of the sequence with its lead pairing.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<TSource>. 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).

Remarks

This operator evaluates in a deferred and streaming manner.