Click or drag to resize

LeadExtensionLeadTSource, TResult Method (IEnumerableTSource, Int32, TSource, FuncTSource, TSource, TResult)

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

Namespace:  MoreLinq.Extensions
Assembly:  MoreLinq (in MoreLinq.dll) Version: 3.0.0
Syntax
public static IEnumerable<TResult> Lead<TSource, TResult>(
	this IEnumerable<TSource> source,
	int offset,
	TSource defaultLeadValue,
	Func<TSource, TSource, TResult> resultSelector
)

Parameters

source
Type: System.Collections.GenericIEnumerableTSource
The sequence over which to evaluate Lead
offset
Type: SystemInt32
The offset (expressed as a positive number) by which to lead each element of the sequence
defaultLeadValue
Type: TSource
A default value supplied for the leading element when none is available
resultSelector
Type: SystemFuncTSource, 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

Type: IEnumerableTResult
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 IEnumerableTSource. 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.
See Also