polars.LazyFrame.gather

LazyFrame.gather(
    indices: int | Sequence[int] | IntoExpr | Series | np.ndarray[Any,
    Any] | LazyFrame,
    *,
    null_on_oob: bool = False,
) → LazyFrame

Выбирает строки из этого LazyFrame по заданным индексам.

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

Предупреждение

Эта функциональность является экспериментальной. Она может быть изменена в любой момент без необходимости считать такие изменения несовместимыми.

Параметры:

indices

Индексы строк, которые нужно выбрать.

Из-за отсутствия LazySeries в качестве индексов также можно передать LazyFrame шириной в один элемент.

null_on_oob

Если значение равно true, то при выходе индекса за допустимые границы вместо ошибки будет создана строка со значением null.

Примеры

>>> lf = pl.LazyFrame({"x": [2, 1, 0], "s": ["foo", "bar", "baz"]})
>>> lf.gather([2, 0, 0]).collect()
shape: (3, 2)
┌─────┬─────┐
│ x   ┆ s   │
│ --- ┆ --- │
│ i64 ┆ str │
╞═════╪═════╡
│ 0   ┆ baz │
│ 2   ┆ foo │
│ 2   ┆ foo │
└─────┴─────┘

>>> lf.gather([0, 10, 1], null_on_oob=True).collect()
shape: (3, 2)
┌──────┬──────┐
│ x    ┆ s    │
│ ---  ┆ ---  │
│ i64  ┆ str  │
╞══════╪══════╡
│ 2    ┆ foo  │
│ null ┆ null │
│ 1    ┆ bar  │
└──────┴──────┘

>>> idxs = pl.LazyFrame({"i": [1, 10, 0], "b": [True, False, True]})
>>> lf.gather(idxs.filter(pl.col.b).select(pl.col.i)).collect()
shape: (2, 2)
┌─────┬─────┐
│ x   ┆ s   │
│ --- ┆ --- │
│ i64 ┆ str │
╞═════╪═════╡
│ 1   ┆ bar │
│ 2   ┆ foo │
└─────┴─────┘