g_rshifti(G;S;O;N)

Returns a zero-indexed row number that is a specified number of rows before (or after) the current row within a given group (rather than the column value).

Function type

Vector only

Syntax

g_rshifti(G;S;O;N)
t_rshifti(N)

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 G are the same.

If G is omitted, all rows are considered to be in the same group.

If any of the columns listed in G contain N/A, the N/A value is considered a valid grouping value.
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 S is omitted, all rows will be considered by the function (subject to any prior row selections).

If any of the values in S are neither 1 nor 0, an error is returned.
O integer A space- or comma-separated list of column names that determine the row order within a particular group

If O is omitted, the order is the current display order of the table.

If any of the values in O are N/A, an error is returned.
N
  • integer
  • big integer
 The number of rows to shift within the group
Note: Support for columns of type big integer available as of version 11.26.

Return Value

For every row in each group defined by G and ordered by O (and for those rows where S=1, if specified):
  • If N >= 0, g_rshifti returns the zero-indexed row that is N rows after this row in the same group as this row.
  • If N < 0, g_rshifti returns the zero-indexed row that is |N| rows before this row in the same group as this row.

Sample Usage

<base table="pub.doc.samples.ref.func.g_func_time_series_sample_usage"/>
<willbe name="g_rshifti_1" value="g_rshifti(state;include;order;1)"/>
<willbe name="g_rshifti_2" value="g_rshifti(state;include;order;-1)"/>

Example: Difference between g_rshift and g_rshifti

This example shows the difference between the g_rshift and g_rshifti functions.

<table cols="state,sel">TX 1
TX 1
TX 1
TX 1
TX 0
TX 0
TX 0
TX 0
TX 0
TN 1
TN 1
TN 1
PA 1
PA 1
PA 1
PA 0
PA 0
DE 0
DE 0
DE 0
</table>
<willbe name="i" value="i_()"/>
<willbe name="g_rshift" value="g_rshift(state;sel;;i;0)-1" format="type:num;width:2"/>
<willbe name="g_rshifti" value="g_rshifti(state;sel;;0)" format="type:num;width:2"/>

Additional Information

  • The t_ version of this function defaults the G argument and omits the S argument. The default for G is set at table load time based on the organization of the table.