 | DataSegmentT Class |
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 ]
[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.
[category:Parameters and results of various operations]
Inheritance HierarchyNamespace: Deedle
Assembly: Deedle (in Deedle.dll) Version: 1.2
SyntaxC#
[SerializableAttribute] public sealed class DataSegment<T> : IEquatable<DataSegment<T>>, IStructuralEquatable, IComparable<DataSegment<T>>, IComparable, IStructuralComparable
Type Parameters
- T
The DataSegmentT type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Data |
Returns the data associated with the segment
(for boundary segment, this may be smaller than the required window size)
|
| Item1 | |
| Item2 | |
| Kind |
Return the kind of this segment
|
| Tag |
Methods| Name | Description | |
|---|---|---|
 | CompareTo(Object) | |
| CompareTo(DataSegmentT) | |
| CompareTo(Object, IComparer) | |
| Equals(Object) | (Overrides ObjectEquals(Object).) |
| Equals(DataSegmentT) | |
| Equals(Object, IEqualityComparer) | |
| get_Item1 | |
| get_Item2 | |
| get_Tag | |
| GetHashCode | (Overrides ObjectGetHashCode.) |
| GetHashCode(IEqualityComparer) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
 | NewDataSegment | |
| ToString |
Format data segment nicely
(Overrides ObjectToString.) |
See Also