DataSegment<'T>

Namespace: Deedle

Represents a segment of a series or sequence. The value is returned from various functions that aggregate data into chunks or floating windows. The Complete case represents complete segment (e.g. of the specified size) and Boundary represents segment at the boundary (e.g. smaller than the required size).

Example

For example (using internal windowed function):

1: 
2: 
3: 
4: 
5: 
6: 
7:

open Deedle.Internal

Seq.windowedWithBounds 3 Boundary.AtBeginning [ 1; 2; 3; 4 ]
[fsi:  [| DataSegment(Incomplete, [| 1 |])         ]
[fsi:       DataSegment(Incomplete, [| 1; 2 |])    ]
[fsi:       DataSegment(Complete [| 1; 2; 3 |])    ]
[fsi:       DataSegment(Complete [| 2; 3; 4 |]) |] ]

If you do not need to distinguish the two cases, you can use the Data property to get the array representing the segment data.

namespace Deedle

namespace Deedle.Internal

Multiple items
module Seq

from Deedle.Internal

--------------------
module Seq

from Microsoft.FSharp.Collections

val windowedWithBounds : size:int -> boundary:Deedle.Boundary -> input:seq<'T> -> seq<Deedle.DataSegment<'T []>>

Full name: Deedle.Internal.Seq.windowedWithBounds

Union Cases

Union Case	Description
`DataSegment(DataSegmentKind,'T)` Signature: DataSegmentKind * 'T

Instance members

Instance member	Description
`Data` Signature: 'T	Returns the data associated with the segment (for boundary segment, this may be smaller than the required window size)
`Kind` Signature: DataSegmentKind	Return the kind of this segment