FSharpx.Collections


Timeseries<'T> Type

Constructors

Constructor Description

Timeseries(startDate, granularity, size)

Full Usage: Timeseries(startDate, granularity, size)

Parameters:
Returns: Timeseries<'T>
startDate : DateTimeOffset
granularity : TimeSpan
size : int
Returns: Timeseries<'T>

Timeseries(startDate, granularity, values)

Full Usage: Timeseries(startDate, granularity, values)

Parameters:
Returns: Timeseries<'T>
startDate : DateTimeOffset
granularity : TimeSpan
values : seq<'T>
Returns: Timeseries<'T>

Timeseries(startDate, granularity, position, values)

Full Usage: Timeseries(startDate, granularity, position, values)

Parameters:
Returns: Timeseries<'T>
startDate : DateTimeOffset
granularity : TimeSpan
position : int
values : seq<'T>
Returns: Timeseries<'T>

Instance members

Instance member Description

this.Advance(toDate)

Full Usage: this.Advance(toDate)

Parameters:
Returns: DateTimeOffset

Advances the start date of the Timeseries to toDate. Throws an ArgumentException if toDate is before the Timeseries start date.

toDate : DateTimeOffset
Returns: DateTimeOffset

this.AsTimeseries(?startDate)

Full Usage: this.AsTimeseries(?startDate)

Parameters:
Returns: (DateTimeOffset * 'T)[]
?startDate : DateTimeOffset
Returns: (DateTimeOffset * 'T)[]

this.Buffer

Full Usage: this.Buffer

Returns: RingBuffer<'T>
Returns: RingBuffer<'T>

this.Clone()

Full Usage: this.Clone()

Returns: Timeseries<'T>
Returns: Timeseries<'T>

this.Granularity

Full Usage: this.Granularity

Returns: TimeSpan
Returns: TimeSpan

this.Insert(op, startDate, gran, dataToInsert)

Full Usage: this.Insert(op, startDate, gran, dataToInsert)

Parameters:
op : 'T -> 'T -> 'T
startDate : DateTimeOffset
gran : TimeSpan
dataToInsert : seq<'T>

this.Merge(f, ts)

Full Usage: this.Merge(f, ts)

Parameters:
f : 'T -> 'T -> 'T
ts : Timeseries<'T>

this.Series

Full Usage: this.Series

Returns: (DateTimeOffset * 'T)[]
Returns: (DateTimeOffset * 'T)[]

this.StartDate

Full Usage: this.StartDate

this.ToGranularity(granularity)

Full Usage: this.ToGranularity(granularity)

Parameters:
Returns: Timeseries<'T>
granularity : TimeSpan
Returns: Timeseries<'T>

this.TryAdvance(toDate)

Full Usage: this.TryAdvance(toDate)

Parameters:
Returns: DateTimeOffset option

Tries to advance the start date of the Timeseries to toDate. Returns None if toDate is before the start date of the Timeseries, otherwise Some containing the start date of the Timeseries.

toDate : DateTimeOffset
Returns: DateTimeOffset option

Static members

Static member Description

Timeseries.Empty(startDate, granularity, size)

Full Usage: Timeseries.Empty(startDate, granularity, size)

Parameters:
Returns: Timeseries<'a>
startDate : DateTimeOffset
granularity : TimeSpan
size : int
Returns: Timeseries<'a>