Grouping.Window Method

public static IGrouping Window(
	IIndex index,
	int size,
	int offset = -1,
	bool includePartialWindows = false,
	int minCount = 0
)

Public Shared Function Window ( 
	index As IIndex,
	size As Integer,
	Optional offset As Integer = -1,
	Optional includePartialWindows As Boolean = false,
	Optional minCount As Integer = 0
) As IGrouping

public:
static IGrouping^ Window(
	IIndex^ index, 
	int size, 
	int offset = -1, 
	bool includePartialWindows = false, 
	int minCount = 0
)

static member Window : 
        index : IIndex * 
        size : int * 
        ?offset : int * 
        ?includePartialWindows : bool * 
        ?minCount : int 
(* Defaults:
        let _offset = defaultArg offset -1
        let _includePartialWindows = defaultArg includePartialWindows false
        let _minCount = defaultArg minCount 0
*)
-> IGrouping 

Parameters

index  IIndex

The index the grouping is over.

size  Int32

The size of the window. Must be greater than zero.

offset  Int32  (Optional)

The offset from the start of the window of the key that is used to represent the group in the grouping's index.

includePartialWindows  Boolean  (Optional)

Indicates whether windows at the boundaries that are smaller than size should be evaluated. The default is false.

minCount  Int32  (Optional)

The minimum number of non-missing values in a window.

Return Value

When offset is less than zero, the key element is counted from the end of the window.

When includePartialWindows is false, the grouping will usually have fewer elements than the index. When includePartialWindows is true, the grouping has as many groups as there are keys in the index, but depending on the value of minCount, some entries may be missing.

public static Grouping<TInput> Window<TInput>(
	Index<TInput> index,
	int size,
	int offset = -1,
	bool includePartialWindows = false,
	int minCount = 0
)

Public Shared Function Window(Of TInput) ( 
	index As Index(Of TInput),
	size As Integer,
	Optional offset As Integer = -1,
	Optional includePartialWindows As Boolean = false,
	Optional minCount As Integer = 0
) As Grouping(Of TInput)

public:
generic<typename TInput>
static Grouping<TInput>^ Window(
	Index<TInput>^ index, 
	int size, 
	int offset = -1, 
	bool includePartialWindows = false, 
	int minCount = 0
)

static member Window : 
        index : Index<'TInput> * 
        size : int * 
        ?offset : int * 
        ?includePartialWindows : bool * 
        ?minCount : int 
(* Defaults:
        let _offset = defaultArg offset -1
        let _includePartialWindows = defaultArg includePartialWindows false
        let _minCount = defaultArg minCount 0
*)
-> Grouping<'TInput> 

Parameters

index  Index<TInput>

The index the grouping is over.

size  Int32

The size of the window. Must be greater than zero.

offset  Int32  (Optional)

The offset from the start of the window of the key that is used to represent the group in the grouping's index.

includePartialWindows  Boolean  (Optional)

Indicates whether windows at the boundaries that are smaller than size should be evaluated. The default is false.

minCount  Int32  (Optional)

(Optional.) The minimum number of observations required for aggregations over a window to have a value. The default is 0.

Type Parameters

TInput

Return Value

public static Grouping<long> Window(
	int length,
	int size,
	int offset = -1,
	bool includePartialWindows = false,
	int minCount = 0
)

Public Shared Function Window ( 
	length As Integer,
	size As Integer,
	Optional offset As Integer = -1,
	Optional includePartialWindows As Boolean = false,
	Optional minCount As Integer = 0
) As Grouping(Of Long)

public:
static Grouping<long long>^ Window(
	int length, 
	int size, 
	int offset = -1, 
	bool includePartialWindows = false, 
	int minCount = 0
)

static member Window : 
        length : int * 
        size : int * 
        ?offset : int * 
        ?includePartialWindows : bool * 
        ?minCount : int 
(* Defaults:
        let _offset = defaultArg offset -1
        let _includePartialWindows = defaultArg includePartialWindows false
        let _minCount = defaultArg minCount 0
*)
-> Grouping<int64> 

Parameters

length  Int32

The total length of the data to group on.

size  Int32

The size of the window. Must be greater than zero.

offset  Int32  (Optional)

(Optional.) The offset from the start of the window of the key that is used to represent the group in the grouping's index. The default is -1, which indicates the last item in the interval.

includePartialWindows  Boolean  (Optional)

Indicates whether windows at the boundaries that are smaller than size should be evaluated.

minCount  Int32  (Optional)

(Optional.) The minimum number of observations required for aggregations over a window to have a value. The default is 0.

Return Value

Reference