MoreEnumerable.Pad(TSource) Method (IEnumerable(TSource), Int32, Func(Int32, TSource))

MoreEnumerablePadTSource Method (IEnumerableTSource, Int32, FuncInt32, TSource)

Pads a sequence with a dynamic filler value if it is narrower (shorter in length) than a given width.

Namespace: MoreLinq
Assembly: MoreLinq (in MoreLinq.dll) Version: 2.1.0

Syntax

public static IEnumerable<TSource> Pad<TSource>(
	this IEnumerable<TSource> source,
	int width,
	Func<int, TSource> paddingSelector
)

<ExtensionAttribute>
Public Shared Function Pad(Of TSource) ( 
	source As IEnumerable(Of TSource),
	width As Integer,
	paddingSelector As Func(Of Integer, TSource)
) As IEnumerable(Of TSource)

public:
[ExtensionAttribute]
generic<typename TSource>
static IEnumerable<TSource>^ Pad(
	IEnumerable<TSource>^ source, 
	int width, 
	Func<int, TSource>^ paddingSelector
)

[<ExtensionAttribute>]
static member Pad : 
        source : IEnumerable<'TSource> * 
        width : int * 
        paddingSelector : Func<int, 'TSource> -> IEnumerable<'TSource>

Parameters

source: Type: System.Collections.GenericIEnumerableTSource
The sequence to pad.
width: Type: SystemInt32
The width/length below which to pad.
paddingSelector: Type: SystemFuncInt32, TSource
Function to calculate padding.

Type Parameters

TSource: The type of the elements of source.

Return Value

Type: IEnumerableTSource
Returns a sequence that is at least as wide/long as the width/length specified by the width parameter.

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 uses deferred execution and streams its results.

Examples

Copy

int[] numbers = { 0, 1, 2 };
IEnumerable<int> result = numbers.Pad(5, i => -i);

The result variable, when iterated over, will yield 0, 1, 2, -3 and -4, in turn.

Reference

MoreEnumerable Class

Pad Overload

MoreLinq Namespace