AggWAvg
AggWAvg returns an aggregator that computes the weighted average of values, within an aggregation group, for each input column.
Syntax
AggWAvg(weightColumn, pairs...)
Parameters
| Parameter | Type | Description |
|---|---|---|
| weightColumn | String | The weight column for the calculation. |
| pairs | String... | The input/output names for the column(s) for the calculations.
|
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 weighted average of values, within an aggregation group, for each input column.
Examples
In this example, AggWAvg returns the weighted average of values of Number, as weighed by Weight and grouped by X.
import static io.deephaven.api.agg.Aggregation.AggWAvg
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),
intCol("Weight", 1, 2, 1, 3, 2, 1, 4, 1, 2),
)
result = source.aggBy([AggWAvg("Weight", "Number")], "X")
- source
- result
In this example, AggWAvg returns the weighted average of values of Number (renamed to WAvgNumber), as weighed by Weight and grouped by X.
import static io.deephaven.api.agg.Aggregation.AggWAvg
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),
intCol("Weight", 1, 2, 1, 3, 2, 1, 4, 1, 2),
)
result = source.aggBy([AggWAvg("Weight", "WAvgNumber = Number")], "X")
- source
- result
In this example, AggWAvg returns the weighted average of values of Number (renamed to WAvgNumber), as weighed by Weight and grouped by X and Y.
import static io.deephaven.api.agg.Aggregation.AggWAvg
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),
intCol("Weight", 1, 2, 1, 3, 2, 1, 4, 1, 2),
)
result = source.aggBy([AggWAvg("Weight", "WAvgNumber = Number")], "X", "Y")
- source
- result
In this example, AggWAvg returns the weighted average of values of Number1 (renamed to WAvgNumber1), and the weighted average of values of Number2 (renamed to WAvgNumber2), both as weighed by Weight and grouped by X.
import static io.deephaven.api.agg.Aggregation.AggWAvg
source = newTable(
stringCol("X", "A", "B", "A", "C", "B", "A", "B", "B", "C"),
intCol("Weight", 1, 2, 1, 3, 2, 1, 4, 1, 2),
intCol("Number1", 55, 76, 20, 130, 230, 50, 73, 137, 214),
intCol("Number2", 25, 14, 51, 23, 12, 15, 17, 72, 21),
)
result = source.aggBy([AggWAvg("Weight", "WAvgNumber1 = Number1", "WAvgNumber2 = Number2")], "X")
- source
- result
In this example, AggWAvg returns the weighted average of values of Number (renamed to WAvgNumber), as weighed by Weight and grouped by X, and AggAvg returns the total average of values of Number, as grouped by X.
import static io.deephaven.api.agg.Aggregation.AggWAvg
import static io.deephaven.api.agg.Aggregation.AggAvg
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),
intCol("Weight", 1, 2, 1, 3, 2, 1, 4, 1, 2),
)
result = source.aggBy([AggWAvg("Weight", "WAvgNumber = Number"),AggAvg("Avg = Number")], "X")
- source
- result