Skip to main content
Version: Python

min

agg.min_ returns an aggregator that computes the minimum value, within an aggregation group, for each input column.

Syntax

min_(cols: List[str]) -> Aggregation

Parameters

ParameterTypeDescription
colsList[str]

The source column(s) for the calculations.

  • ["X"] will output the minimum value in the X column for each group.
  • ["Y = X"] will output the minimum value in the X column for each group and rename it to Y.
  • ["X, A = B"] will output the minimum value in the X column for each group and the minimum value in the B column while 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.agg_by([agg.sum_(cols=[“X”]), agg.avg(cols=["X"]), both the sum and the average aggregators produce column X, which results in an error.

Returns

An aggregator that computes the minimum value, within an aggregation group, for each input column.

Examples

In this example, agg.min_ returns the minimum Y value as grouped by X.

from deephaven import new_table
from deephaven.column import string_col, int_col, double_col
from deephaven import agg as agg

source = new_table([
string_col("X", ["A", "B", "A", "C", "B", "A", "B", "B", "C"]),
string_col("Y", ["M", "N", "O", "N", "P", "M", "O", "P", "M"]),
int_col("Number", [55, 76, 20, 130, 230, 50, 73, 137, 214]),
])

result = source.agg_by([agg.min_(cols=["Y"])], by=["X"])

In this example, agg.min_ returns the minimum Y value (renamed to Z), as grouped by X.

from deephaven import new_table
from deephaven.column import string_col, int_col, double_col
from deephaven import agg as agg

source = new_table([
string_col("X", ["A", "B", "A", "C", "B", "A", "B", "B", "C"]),
string_col("Y", ["M", "N", "O", "N", "P", "M", "O", "P", "M"]),
int_col("Number", [55, 76, 20, 130, 230, 50, 73, 137, 214]),
])

result = source.agg_by([agg.min_(cols=["Z = Y"])], by=["X"])

In this example, agg.min_ returns the minimum Y string and minimum Number integer as grouped by X.

from deephaven import new_table
from deephaven.column import string_col, int_col, double_col
from deephaven import agg as agg

source = new_table([
string_col("X", ["A", "B", "A", "C", "B", "A", "B", "B", "C"]),
string_col("Y", ["M", "N", "O", "N", "P", "M", "O", "P", "M"]),
int_col("Number", [55, 76, 20, 130, 230, 50, 73, 137, 214]),
])

result = source.agg_by([agg.min_(cols=["Y", "Number"])], by=["X"])

In this example, agg.min_ returns the minimum Number, as grouped by X and Y.

from deephaven import new_table
from deephaven.column import string_col, int_col, double_col
from deephaven import agg as agg

source = new_table([
string_col("X", ["A", "B", "A", "C", "B", "A", "B", "B", "C"]),
string_col("Y", ["M", "P", "O", "N", "P", "M", "O", "P", "N"]),
int_col("Number", [55, 76, 20, 130, 230, 50, 73, 137, 214]),
])

result = source.agg_by([agg.min_(cols=["Number"])], by=["X", "Y"])

In this example, agg.min_ returns the minimum Number, and agg.max_ returns the maximum Number, as grouped by X.

from deephaven import new_table
from deephaven.column import string_col, int_col, double_col
from deephaven import agg as agg

source = new_table([
string_col("X", ["A", "B", "A", "C", "B", "A", "B", "B", "C"]),
string_col("Y", ["M", "P", "O", "N", "P", "M", "O", "P", "N"]),
int_col("Number", [55, 76, 20, 130, 230, 50, 73, 137, 214]),
])

result = source.agg_by([agg.min_(cols=["MinNumber = Number"])], by=["X"])