Header menu logo bristlecone

TimeIndex Module

Types

Type Description

IndexMode<'a>

TimeIndex<'a>

A representation of temporal data as fractions of a common fixed temporal resolution, from a given baseline. The baseline must be greater than or equal to the baseline of the time series.

Functions and values

Function or value Description

indexSeries t0 targetResolution series

Full Usage: indexSeries t0 targetResolution series

Parameters:
Returns: (float * 'a) seq

Indexes the time series in accordance with a `baselineTime` and fixed `resolution`. Where the time series is of a lower resolution

t0 : DateTime
targetResolution : FixedTemporalResolution
series : TimeSeries<'a>
Returns: (float * 'a) seq

totalMonthsElapsed d1 d2

Full Usage: totalMonthsElapsed d1 d2

Parameters:
Returns: float
d1 : DateTime
d2 : DateTime
Returns: float

totalYearsElapsed d1 d2

Full Usage: totalYearsElapsed d1 d2

Parameters:
Returns: float
d1 : DateTime
d2 : DateTime
Returns: float

totalYearsElapsed' d1 d2

Full Usage: totalYearsElapsed' d1 d2

Parameters:
Returns: float

Algorithm that ignores leap year days. Truncation occurs for 29th Feburary. Actual days count basis.

d1 : DateTime
d2 : DateTime
Returns: float

totalYearsElapsedFraction d1 d2

Full Usage: totalYearsElapsedFraction d1 d2

Parameters:
Returns: float

Calculates the fractional number of years elapsed between two dates. The basis used is actual/actual.

d1 : DateTime
d2 : DateTime
Returns: float

Type something to start searching.