Logo Deedle

Aggregation Type

A non-generic type that simplifies the construction of Aggregation<K> values from C#. It provides methods for constructing different kinds of aggregation strategies for ordered series.

Static members

Static member Description

Aggregation.ChunkSize(size, boundary)

Full Usage: Aggregation.ChunkSize(size, boundary)

Parameters:
    size : int - Specifies the size of the floating window. Depending on the boundary behavior, the actual created windows may be smaller.
    boundary : Boundary - Specifies how to handle boundaries (when there is not enough data to create an entire window).

Returns: Aggregation<'a>
Type parameters: 'a

Aggregate data into non-overlapping chunks of a specified size and the provided handling of boundary elements.

size : int

Specifies the size of the floating window. Depending on the boundary behavior, the actual created windows may be smaller.

boundary : Boundary

Specifies how to handle boundaries (when there is not enough data to create an entire window).

Returns: Aggregation<'a>

Aggregation.ChunkWhile(condition)

Full Usage: Aggregation.ChunkWhile(condition)

Parameters:
    condition : Func<'K, 'K, bool> - A delegate that specifies when to end the current chunk (e.g. (k1, k2) => k2 - k1 < 10 means that the difference between keys in each chunk will be less than 10.

Returns: Aggregation<'K>
Type parameters: 'K

Aggregate data into non-overlapping chunks where each chunk ends as soon as the specified function returns `false` when called with the first key and the current key as arguments.

condition : Func<'K, 'K, bool>

A delegate that specifies when to end the current chunk (e.g. (k1, k2) => k2 - k1 < 10 means that the difference between keys in each chunk will be less than 10.

Returns: Aggregation<'K>

Aggregation.WindowSize(size, boundary)

Full Usage: Aggregation.WindowSize(size, boundary)

Parameters:
    size : int - Specifies the size of the floating window. Depending on the boundary behavior, the actual created windows may be smaller.
    boundary : Boundary - Specifies how to handle boundaries (when there is not enough data to create an entire window).

Returns: Aggregation<'a>
Type parameters: 'a

Aggregate data into floating windows of a specified size and the provided handling of boundary elements.

size : int

Specifies the size of the floating window. Depending on the boundary behavior, the actual created windows may be smaller.

boundary : Boundary

Specifies how to handle boundaries (when there is not enough data to create an entire window).

Returns: Aggregation<'a>

Aggregation.WindowWhile(condition)

Full Usage: Aggregation.WindowWhile(condition)

Parameters:
    condition : Func<'K, 'K, bool> - A delegate that specifies when to end the current window (e.g. (k1, k2) => k2 - k1 < 10 means that the difference between keys in each window will be less than 10.

Returns: Aggregation<'K>
Type parameters: 'K

Aggregate data into floating windows where each window ends as soon as the specified function returns `false` when called with the first key and the current key as arguments.

condition : Func<'K, 'K, bool>

A delegate that specifies when to end the current window (e.g. (k1, k2) => k2 - k1 < 10 means that the difference between keys in each window will be less than 10.

Returns: Aggregation<'K>

Aggregation.WindowWhileFromEnd(condition)

Full Usage: Aggregation.WindowWhileFromEnd(condition)

Parameters:
    condition : Func<'K, 'K, bool> - A delegate that specifies when to extend the window backward (e.g. (k1, k2) => k2 - k1 < 10 means that the difference between the first and last key in each window will be less than 10).

Returns: Aggregation<'K>
Type parameters: 'K

Aggregate data into floating windows where each window ends at the current element. The window starts at the earliest key for which the specified function returns true when called with the start key and the current (end) key. The key of each produced window is the last (end) key of the window.

condition : Func<'K, 'K, bool>

A delegate that specifies when to extend the window backward (e.g. (k1, k2) => k2 - k1 < 10 means that the difference between the first and last key in each window will be less than 10).

Returns: Aggregation<'K>

Type something to start searching.