Function intRanges

  • intRanges(
        start: any,
        end: any,
        step?: number,
        dtype?: DataType,
        eager?: false,
    ): pl.Expr

  • Generate a range of integers for each row of the input columns.

    Parameters

    • start: any

      Start of the range (inclusive). Defaults to 0.

    • end: any

      End of the range (exclusive). If set to None (default), the value of start is used and start is set to 0.

    • Optionalstep: number

      Step size of the range.

    • Optionaldtype: DataType

      Integer data type of the ranges. Defaults to Int64.

    • Optionaleager: false

      Evaluate immediately and return a Series. If set to False (default), return an expression instead.

    Returns pl.Expr

    • Expr or Series Column of data type List(dtype).

    See

    intRange

    Example

    const df = pl.DataFrame({"a": [1, 2], "b": [3, 4]})
    const result = df.select(pl.intRanges("a", "b"));
  • intRanges(
        start: any,
        end: any,
        step?: number,
        dtype?: DataType,
        eager?: true,
    ): pl.Series

  • Generate a range of integers for each row of the input columns.

    Parameters

    • start: any

      Start of the range (inclusive). Defaults to 0.

    • end: any

      End of the range (exclusive). If set to None (default), the value of start is used and start is set to 0.

    • Optionalstep: number

      Step size of the range.

    • Optionaldtype: DataType

      Integer data type of the ranges. Defaults to Int64.

    • Optionaleager: true

      Evaluate immediately and return a Series. If set to False (default), return an expression instead.

    Returns pl.Series

    • Expr or Series Column of data type List(dtype).

    See

    intRange

    Example

    const df = pl.DataFrame({"a": [1, 2], "b": [3, 4]})
    const result = df.select(pl.intRanges("a", "b"));

Settings

Member Visibility