Constructs a grouping that represents a moving window of fixed length.
Namespace:
Extreme.DataAnalysis
Assembly:
Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
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
- Type: Extreme.DataAnalysisIIndex
The index the grouping is over. - size
- Type: SystemInt32
The size of the window. Must be greater than zero. - offset (Optional)
- Type: SystemInt32
The offset from the start of the window
of the key that is used to represent the group in the grouping's index. - includePartialWindows (Optional)
- Type: SystemBoolean
Indicates whether windows at the boundaries
that are smaller than size should be evaluated.
The default is .
- minCount (Optional)
- Type: SystemInt32
The minimum number of non-missing values in a window.
Return Value
Type:
IGroupingA grouping object that represents the moving window.
Reference