DataSegment<'T> (Deedle)

DataSegment<'T> Type

Namespace: Deedle
Assembly: Deedle.dll
Base Type: obj
All Interfaces: IEquatable<DataSegment<'T>> , IStructuralEquatable , IComparable<DataSegment<'T>> , IComparable , IStructuralComparable

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):

 open Deedle.Internal

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

module Seq from Microsoft.FSharp.Collections

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

Union cases

Union case	Description
`DataSegment(DataSegmentKind, 'T)` Full Usage: `DataSegment(DataSegmentKind, 'T)` Parameters: Item1 : `DataSegmentKind` Item2 : `'T`	Item1 : `DataSegmentKind` Item2 : `'T`

Instance members

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