g_cumlo(G;S;O;X)
Returns the cumulative minimum within a given group.
Function type
Vector only
Syntax
g_cumlo(G;S;O;X)
t_cumlo(X)
Input
Argument | Type | Description |
---|---|---|
G |
any | A space- or comma-separated list of column names Rows are in the same group
if their values for all of the columns listed in If If any of the columns listed in |
S |
integer | The name of a column in which every row evaluates to a 1 or 0, which determines
whether or not that row is selected to be included in the calculation If
If any of the values in
|
O |
integer | A space- or comma-separated list of column names that
determine the row order within a particular group If
If any of the values in |
X |
integer or decimal | A column name An N/A in |
Return Value
For every row in each group defined by G
and ordered by O
(and for those rows where S
=1, if specified),
g_cumlo
returns the lowest value in the column listed in
X
within all rows up to and including that row. The result is the same
data type as X
.
If no rows in a group have valid (non-N/A) values for X
, the result for every
row of the group is 0I
(positive infinity).
Sample Usage
<base table="pub.doc.samples.ref.func.g_func_time_series_sample_usage"/> <willbe name="g_cumlo_1" value="g_cumlo(state;include;order;value)"/> <willbe name="g_cumlo_2" value="g_cumlo(state city;include;order;value)"/>
Additional Information
- The
t_
version of this function defaults theG
argument and omits theS
argument. The default forG
is set at table load time based on the organization of the table.