GrowthSeries Module
A specific type of time series that represents growth in a phenomena over time.
Types
| Type | Description |
|
|
Functions and values
| Function or value |
Description
|
Full Usage:
GrowthSeries.absolute growth
Parameters:
GrowthSeries<'u, 'time, 'date, 'timeunit, 'timespan>
Returns: TimeSeries<float<MeasureProduct<MeasureInverse<'time>, MeasureProduct<'u, MeasureOne>>>, 'date, 'timeunit, 'timespan>
|
|
Full Usage:
GrowthSeries.asCumulative plant
Parameters:
GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'w, 'a, 'b, 'c>
|
|
Full Usage:
GrowthSeries.asRelative plant
Parameters:
GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'w, 'x, 'a, 'b, 'c>
|
|
Full Usage:
GrowthSeries.bound d1 d2 growth
Parameters:
'a
d2 : 'a
growth : GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'v, 'a, 'b, 'c> option
|
|
Full Usage:
GrowthSeries.cumulative growth
Parameters:
GrowthSeries<'u, 'time, 'date, 'timeunit, 'timespan>
Returns: TimeSeries<float<'u>, 'date, 'timeunit, 'timespan>
|
Converts the given growth series into its cumulative representation (i.e. added over time).
|
Full Usage:
GrowthSeries.filter times growth
Parameters:
'a seq
growth : GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'v, 'a, 'b, 'c>
|
Filter a growth series to only contain observations at the specified dates.
|
Full Usage:
GrowthSeries.relative growth
Parameters:
GrowthSeries<'u, 'v, 'date, 'timeunit, 'timespan>
Returns: TimeSeries<float<MeasureOne>, 'date, 'timeunit, 'timespan>
|
Converts the given growth series into its relative representation (i.e. current growth rate divided by current cumulative size).
|
Full Usage:
GrowthSeries.tail growth
Parameters:
GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'w, 'a, 'b, 'c>
|
|
bristlecone