AggSum

AggSum returns an aggregator that computes the total sum of values, within an aggregation group, for each input column.

Syntax

AggSum(pairs...)

Parameters

ParameterTypeDescription
pairsString...

The input/output name pairs.

  • "X" will output the total sum of values in the X column for each group.
  • "Y = X" will output the total sum of values in the X column for each group and rename it to Y.
  • "X, A = B" will output the total sum of values in the X column for each group and the total sum of values in the B value column renaming it to A.

Caution

If an aggregation does not rename the resulting column, the aggregation column will appear in the output table, not the input column. If multiple aggregations on the same column do not rename the resulting columns, an error will result, because the aggregations are trying to create multiple columns with the same name. For example, in table.aggBy([agg.AggSum(“X”), agg.AggAvg(“X”)]), both the sum and the average aggregators produce column X, which results in an error.

Returns

An aggregator that computes the total sum of values, within an aggregation group, for each input column.

Examples

In this example, AggSum returns the total sum of values of Number as grouped by X.

import static io.deephaven.api.agg.Aggregation.AggSum

source = newTable(
    stringCol("X", "A", "B", "A", "C", "B", "A", "B", "B", "C"),
    stringCol("Y", "M", "N", "O", "N", "P", "M", "O", "P", "M"),
    intCol("Number", 55, 76, 20, 130, 230, 50, 73, 137, 214),
)

result = source.aggBy([AggSum("Number")], "X")

In this example, AggSum returns the total sum of values of Number (renamed to Z), as grouped by X.

import static io.deephaven.api.agg.Aggregation.AggSum

source = newTable(
    stringCol("X", "A", "B", "A", "C", "B", "A", "B", "B", "C"),
    stringCol("Y", "M", "N", "O", "N", "P", "M", "O", "P", "M"),
    intCol("Number", 55, 76, 20, 130, 230, 50, 73, 137, 214),
)

result = source.aggBy([AggSum("Z = Number")], "X")

In this example, AggSum returns the total sum of values of Number (renamed to Z), as grouped by X and Y.

import static io.deephaven.api.agg.Aggregation.AggSum

source = newTable(
    stringCol("X", "A", "B", "A", "C", "B", "A", "B", "B", "C"),
    stringCol("Y", "M", "N", "O", "N", "P", "M", "O", "P", "M"),
    intCol("Number", 55, 76, 20, 130, 230, 50, 73, 137, 214),
)

result = source.aggBy([AggSum("Z = Number")], "X", "Y")

In this example, AggSum returns the total sum of values of Number, and AggMax returns the maximum Number , as grouped by X.

import static io.deephaven.api.agg.Aggregation.AggSum
import static io.deephaven.api.agg.Aggregation.AggMax

source = newTable(
    stringCol("X", "A", "B", "A", "C", "B", "A", "B", "B", "C"),
    stringCol("Y", "M", "N", "O", "N", "P", "M", "O", "P", "M"),
    intCol("Number", 55, 76, 20, 130, 230, 50, 73, 137, 214),
)

result = source.aggBy([AggSum("SumNumber = Number"),AggMax("MaxNumber = Number")], "X")