g_dot(G;S;X;Y)

Returns the dot product of two sets of values within a given group.

Function type

Vector only

Syntax

g_dot(G;S;X;Y)

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.
X any numeric type A column name

Rows where X and/or Y are N/A are ignored (i.e., the result is the dot product of the remaining rows).
Y any numeric type A column name containing the data that will be operated on by the group summarization function when calculating the dot product

Rows where X and/or Y are N/A are ignored (i.e., the result is the dot product of the remaining rows).

Return Value

For every row in each group defined by G (and for those rows where S=1, if specified), g_dot returns a decimal value corresponding to the dot product of the values in the column listed in X and the values in the column listed in Y that are in the same group as that row.

If no rows have valid (non-N/A) values for both X and Y, the result is 0.

Sample Usage

<base table="pub.doc.samples.ref.func.g_func_sample_usage_two_values"/>
<willbe name="g_dot_1" value="g_dot(state;include;value1;value2)"/>
<willbe name="g_dot_2" value="g_dot(state city;include;value1;value2)"/>