Header menu logo bristlecone

GrowthSeries Module

A specific type of time series that represents
 growth in a phenomena over time.

Types

Type Description

GrowthSeries<'u, 'time, 'date, 'timeunit, 'timespan>

Functions and values

Function or value Description

GrowthSeries.absolute growth

Full Usage: GrowthSeries.absolute growth

Parameters:
    growth : GrowthSeries<'u, 'time, 'date, 'timeunit, 'timespan>

Returns: TimeSeries<float<MeasureProduct<MeasureInverse<'time>, MeasureProduct<'u, MeasureOne>>>, 'date, 'timeunit, 'timespan>
growth : GrowthSeries<'u, 'time, 'date, 'timeunit, 'timespan>
Returns: TimeSeries<float<MeasureProduct<MeasureInverse<'time>, MeasureProduct<'u, MeasureOne>>>, 'date, 'timeunit, 'timespan>

GrowthSeries.asCumulative plant

Full Usage: GrowthSeries.asCumulative plant

Parameters:
Returns: GrowthSeries<'u, 'w, 'a, 'b, 'c>
plant : GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'w, 'a, 'b, 'c>

GrowthSeries.asRelative plant

Full Usage: GrowthSeries.asRelative plant

Parameters:
Returns: GrowthSeries<'w, 'x, 'a, 'b, 'c>
plant : GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'w, 'x, 'a, 'b, 'c>

GrowthSeries.bound d1 d2 growth

Full Usage: GrowthSeries.bound d1 d2 growth

Parameters:
Returns: GrowthSeries<'u, 'v, 'a, 'b, 'c> option
d1 : 'a
d2 : 'a
growth : GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'v, 'a, 'b, 'c> option

GrowthSeries.cumulative growth

Full Usage: GrowthSeries.cumulative growth

Parameters:
    growth : 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).
growth : GrowthSeries<'u, 'time, 'date, 'timeunit, 'timespan>
Returns: TimeSeries<float<'u>, 'date, 'timeunit, 'timespan>

GrowthSeries.filter times growth

Full Usage: GrowthSeries.filter times growth

Parameters:
Returns: GrowthSeries<'u, 'v, 'a, 'b, 'c>

Filter a growth series to only contain observations at the specified dates.

times : 'a seq
growth : GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'v, 'a, 'b, 'c>

GrowthSeries.relative growth

Full Usage: GrowthSeries.relative growth

Parameters:
    growth : 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).
growth : GrowthSeries<'u, 'v, 'date, 'timeunit, 'timespan>
Returns: TimeSeries<float<MeasureOne>, 'date, 'timeunit, 'timespan>

GrowthSeries.tail growth

Full Usage: GrowthSeries.tail growth

Parameters:
Returns: GrowthSeries<'u, 'w, 'a, 'b, 'c>
growth : GrowthSeries<'u, 'v, 'a, 'b, 'c>
Returns: GrowthSeries<'u, 'w, 'a, 'b, 'c>

Type something to start searching.