polars.Expr.is_between

Expr.is_between(
    lower_bound: IntoExpr,
    upper_bound: IntoExpr,
    closed: ClosedInterval = 'both',
) → Expr

Проверяет, находится ли это выражение между заданными нижней и верхней границами.

движок:В памятиПотоковая обработкаРаспределённый

Параметры:

lower_bound

Значение нижней границы. Принимает выражение. Строки интерпретируются как имена столбцов, остальные значения, не являющиеся выражениями, — как литералы.

upper_bound

Значение верхней границы. Принимает выражение. Строки интерпретируются как имена столбцов, остальные значения, не являющиеся выражениями, — как литералы.

closed{‘both’, ‘left’, ‘right’, ‘none’}

Задаёт, какие стороны интервала включаются в него.

Возвращает:

Expr

Выражение типа данных Boolean.

Примечания

Если значение lower_bound больше значения upper_bound, результатом будет False, так как ни одно значение не может удовлетворять условию.

Примеры

>>> df = pl.DataFrame({"num": [1, 2, 3, 4, 5]})
>>> df.with_columns(pl.col("num").is_between(2, 4).alias("is_between"))
shape: (5, 2)
┌─────┬────────────┐
│ num ┆ is_between │
│ --- ┆ ---        │
│ i64 ┆ bool       │
╞═════╪════════════╡
│ 1   ┆ false      │
│ 2   ┆ true       │
│ 3   ┆ true       │
│ 4   ┆ true       │
│ 5   ┆ false      │
└─────┴────────────┘

Используйте аргумент closed, чтобы включить или исключить значения на границах:

>>> df.with_columns(
...     pl.col("num").is_between(2, 4, closed="left").alias("is_between")
... )
shape: (5, 2)
┌─────┬────────────┐
│ num ┆ is_between │
│ --- ┆ ---        │
│ i64 ┆ bool       │
╞═════╪════════════╡
│ 1   ┆ false      │
│ 2   ┆ true       │
│ 3   ┆ true       │
│ 4   ┆ false      │
│ 5   ┆ false      │
└─────┴────────────┘

Можно также использовать строки, а также числовые значения и значения времени (примечание: заключайте строковые литералы в lit, чтобы не спутать их с именами столбцов):

>>> df = pl.DataFrame({"a": ["a", "b", "c", "d", "e"]})
>>> df.with_columns(
...     pl.col("a")
...     .is_between(pl.lit("a"), pl.lit("c"), closed="both")
...     .alias("is_between")
... )
shape: (5, 2)
┌─────┬────────────┐
│ a   ┆ is_between │
│ --- ┆ ---        │
│ str ┆ bool       │
╞═════╪════════════╡
│ a   ┆ true       │
│ b   ┆ true       │
│ c   ┆ true       │
│ d   ┆ false      │
│ e   ┆ false      │
└─────┴────────────┘

Используйте выражения столбцов в качестве нижней и верхней границ, сравнивая их с литеральным значением:

>>> df = pl.DataFrame({"a": [1, 2, 3, 4, 5], "b": [5, 4, 3, 2, 1]})
>>> df.with_columns(
...     pl.lit(3).is_between(pl.col("a"), pl.col("b")).alias("between_ab")
... )
shape: (5, 3)
┌─────┬─────┬────────────┐
│ a   ┆ b   ┆ between_ab │
│ --- ┆ --- ┆ ---        │
│ i64 ┆ i64 ┆ bool       │
╞═════╪═════╪════════════╡
│ 1   ┆ 5   ┆ true       │
│ 2   ┆ 4   ┆ true       │
│ 3   ┆ 3   ┆ true       │
│ 4   ┆ 2   ┆ false      │
│ 5   ┆ 1   ┆ false      │
└─────┴─────┴────────────┘