Commit 50d4d6fa authored by Brian Brazil's avatar Brian Brazil

Merge pull request #431 from brian-brazil/hw

Document holt_winters()
parents fe64751e 56ee36bb
...@@ -158,6 +158,16 @@ for quantiles located in the lowest bucket. ...@@ -158,6 +158,16 @@ for quantiles located in the lowest bucket.
If `b` contains fewer than two buckets, `NaN` is returned. For φ < 0, `-Inf` is If `b` contains fewer than two buckets, `NaN` is returned. For φ < 0, `-Inf` is
returned. For φ > 1, `+Inf` is returned. returned. For φ > 1, `+Inf` is returned.
## `holt_winters()`
`holt_winters(v range-vector, sf scalar, tf scalar)` produces a smoothed value
for time series based on the range in `v`. The lower the smoothing factor `sf`,
the more importance is given to old data. The higher the trend factor `tf`, the
more trends in the data is considered. Both `sf` and `tf` must be between 0 and
1.
`holt_winters` should only be used with gauges.
## `increase()` ## `increase()`
`increase(v range-vector)` calculates the increase in the `increase(v range-vector)` calculates the increase in the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment