Commit a2989085 authored by James Sanford's avatar James Sanford Committed by Fabian Reinartz

Add documentation for clamp_max() and clamp_min()

This closes #267
parent 5e8edc56
...@@ -51,6 +51,16 @@ For each input time series, `changes(v range-vector)` returns the number of ...@@ -51,6 +51,16 @@ For each input time series, `changes(v range-vector)` returns the number of
times its value has changed within the provided time range as an instant times its value has changed within the provided time range as an instant
vector. vector.
## `clamp_max()`
`clamp_max(v instant-vector, max scalar)` clamps the sample values of all
elements in `v` to have an upper limit of `max`.
## `clamp_min()`
`clamp_min(v instant-vector, min scalar)` clamps the sample values of all
elements in `v` to have a lower limit of `min`.
## `count_scalar()` ## `count_scalar()`
`count_scalar(v instant-vector)` returns the number of elements in a time series `count_scalar(v instant-vector)` returns the number of elements in a time series
......
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