Grouping.Window Method

Definition

Namespace: Extreme.DataAnalysis
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23

Overload List

Window(IIndex, Int32, Int32, Boolean, Int32)	Constructs a grouping that represents a moving window of fixed length.
Window(Int32, Int32, Int32, Boolean, Int32)	Constructs a grouping that represents a moving window of fixed length.
Window<T>(Index<T>, Int32, Int32, Boolean, Int32)	Constructs a grouping that represents a moving window of fixed length.

Grouping.Window(IIndex, Int32, Int32, Boolean, Int32)

Constructs a grouping that represents a moving window of fixed length.

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

Visual Basic

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

C++/CLI

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

IGrouping
A grouping object that represents the moving window.

Exceptions

ArgumentNullException	index is null
ArgumentOutOfRangeException	size is less than or equal to zero.

Grouping.Window<T>(Index<T>, Int32, Int32, Boolean, Int32)

Constructs a grouping that represents a moving window of fixed length.

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

Visual Basic

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

C++/CLI

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

static member Window : 
        index : Index<'T> * 
        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<'T>

Parameters

index Index<T>: 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

T

Return Value

Grouping<T>
A grouping object that represents the moving window.

Exceptions

ArgumentNullException	index is null
ArgumentOutOfRangeException	size is less than or equal to zero.

Grouping.Window(Int32, Int32, Int32, Boolean, Int32)

Constructs a grouping that represents a moving window of fixed length.

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

Visual Basic

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)

C++/CLI

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

Grouping<Int64>
A grouping object that represents the moving window.

Exceptions

ArgumentOutOfRangeException

size is less than or equal to zero.

Grouping.Window Method

Definition

Overload List

Grouping.Window(IIndex, Int32, Int32, Boolean, Int32)

Parameters

Return Value

Exceptions

Grouping.Window<T>(Index<T>, Int32, Int32, Boolean, Int32)

Parameters

Type Parameters

Return Value

Exceptions

Grouping.Window(Int32, Int32, Int32, Boolean, Int32)

Parameters

Return Value

Exceptions

See Also

Reference