polars-df 0.7.0-x86_64-linux → 0.9.0-x86_64-linux

data/lib/polars/functions/aggregation/horizontal.rb

@@ -0,0 +1,246 @@
+module Polars
+  module Functions
+    # Compute the bitwise AND horizontally across columns.
+    #
+    # @param exprs [Array]
+    #   Column(s) to use in the aggregation. Accepts expression input. Strings are
+    #   parsed as column names, other non-expression inputs are parsed as literals.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [false, false, true, true, false, nil],
+    #       "b" => [false, true, true, nil, nil, nil],
+    #       "c" => ["u", "v", "w", "x", "y", "z"]
+    #     }
+    #   )
+    #   df.with_columns(all: Polars.all_horizontal("a", "b"))
+    #   # =>
+    #   # shape: (6, 4)
+    #   # ┌───────┬───────┬─────┬───────┐
+    #   # │ a     ┆ b     ┆ c   ┆ all   │
+    #   # │ ---   ┆ ---   ┆ --- ┆ ---   │
+    #   # │ bool  ┆ bool  ┆ str ┆ bool  │
+    #   # ╞═══════╪═══════╪═════╪═══════╡
+    #   # │ false ┆ false ┆ u   ┆ false │
+    #   # │ false ┆ true  ┆ v   ┆ false │
+    #   # │ true  ┆ true  ┆ w   ┆ true  │
+    #   # │ true  ┆ null  ┆ x   ┆ null  │
+    #   # │ false ┆ null  ┆ y   ┆ false │
+    #   # │ null  ┆ null  ┆ z   ┆ null  │
+    #   # └───────┴───────┴─────┴───────┘
+    def all_horizontal(*exprs)
+      rbexprs = Utils.parse_as_list_of_expressions(*exprs)
+      Utils.wrap_expr(Plr.all_horizontal(rbexprs))
+    end
+
+    # Compute the bitwise OR horizontally across columns.
+    #
+    # @param exprs [Array]
+    #   Column(s) to use in the aggregation. Accepts expression input. Strings are
+    #   parsed as column names, other non-expression inputs are parsed as literals.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [false, false, true, true, false, nil],
+    #       "b" => [false, true, true, nil, nil, nil],
+    #       "c" => ["u", "v", "w", "x", "y", "z"]
+    #     }
+    #   )
+    #   df.with_columns(any: Polars.any_horizontal("a", "b"))
+    #   # =>
+    #   # shape: (6, 4)
+    #   # ┌───────┬───────┬─────┬───────┐
+    #   # │ a     ┆ b     ┆ c   ┆ any   │
+    #   # │ ---   ┆ ---   ┆ --- ┆ ---   │
+    #   # │ bool  ┆ bool  ┆ str ┆ bool  │
+    #   # ╞═══════╪═══════╪═════╪═══════╡
+    #   # │ false ┆ false ┆ u   ┆ false │
+    #   # │ false ┆ true  ┆ v   ┆ true  │
+    #   # │ true  ┆ true  ┆ w   ┆ true  │
+    #   # │ true  ┆ null  ┆ x   ┆ true  │
+    #   # │ false ┆ null  ┆ y   ┆ null  │
+    #   # │ null  ┆ null  ┆ z   ┆ null  │
+    #   # └───────┴───────┴─────┴───────┘
+    def any_horizontal(*exprs)
+      rbexprs = Utils.parse_as_list_of_expressions(*exprs)
+      Utils.wrap_expr(Plr.any_horizontal(rbexprs))
+    end
+
+    # Get the maximum value horizontally across columns.
+    #
+    # @param exprs [Array]
+    #   Column(s) to use in the aggregation. Accepts expression input. Strings are
+    #   parsed as column names, other non-expression inputs are parsed as literals.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 8, 3],
+    #       "b" => [4, 5, nil],
+    #       "c" => ["x", "y", "z"]
+    #     }
+    #   )
+    #   df.with_columns(max: Polars.max_horizontal("a", "b"))
+    #   # =>
+    #   # shape: (3, 4)
+    #   # ┌─────┬──────┬─────┬─────┐
+    #   # │ a   ┆ b    ┆ c   ┆ max │
+    #   # │ --- ┆ ---  ┆ --- ┆ --- │
+    #   # │ i64 ┆ i64  ┆ str ┆ i64 │
+    #   # ╞═════╪══════╪═════╪═════╡
+    #   # │ 1   ┆ 4    ┆ x   ┆ 4   │
+    #   # │ 8   ┆ 5    ┆ y   ┆ 8   │
+    #   # │ 3   ┆ null ┆ z   ┆ 3   │
+    #   # └─────┴──────┴─────┴─────┘
+    def max_horizontal(*exprs)
+      rbexprs = Utils.parse_as_list_of_expressions(*exprs)
+      Utils.wrap_expr(Plr.max_horizontal(rbexprs))
+    end
+
+    # Get the minimum value horizontally across columns.
+    #
+    # @param exprs [Array]
+    #   Column(s) to use in the aggregation. Accepts expression input. Strings are
+    #   parsed as column names, other non-expression inputs are parsed as literals.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 8, 3],
+    #       "b" => [4, 5, nil],
+    #       "c" => ["x", "y", "z"]
+    #     }
+    #   )
+    #   df.with_columns(min: Polars.min_horizontal("a", "b"))
+    #   # =>
+    #   # shape: (3, 4)
+    #   # ┌─────┬──────┬─────┬─────┐
+    #   # │ a   ┆ b    ┆ c   ┆ min │
+    #   # │ --- ┆ ---  ┆ --- ┆ --- │
+    #   # │ i64 ┆ i64  ┆ str ┆ i64 │
+    #   # ╞═════╪══════╪═════╪═════╡
+    #   # │ 1   ┆ 4    ┆ x   ┆ 1   │
+    #   # │ 8   ┆ 5    ┆ y   ┆ 5   │
+    #   # │ 3   ┆ null ┆ z   ┆ 3   │
+    #   # └─────┴──────┴─────┴─────┘
+    def min_horizontal(*exprs)
+      rbexprs = Utils.parse_as_list_of_expressions(*exprs)
+      Utils.wrap_expr(Plr.min_horizontal(rbexprs))
+    end
+
+    # Sum all values horizontally across columns.
+    #
+    # @param exprs [Array]
+    #   Column(s) to use in the aggregation. Accepts expression input. Strings are
+    #   parsed as column names, other non-expression inputs are parsed as literals.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 8, 3],
+    #       "b" => [4, 5, nil],
+    #       "c" => ["x", "y", "z"]
+    #     }
+    #   )
+    #   df.with_columns(sum: Polars.sum_horizontal("a", "b"))
+    #   # =>
+    #   # shape: (3, 4)
+    #   # ┌─────┬──────┬─────┬─────┐
+    #   # │ a   ┆ b    ┆ c   ┆ sum │
+    #   # │ --- ┆ ---  ┆ --- ┆ --- │
+    #   # │ i64 ┆ i64  ┆ str ┆ i64 │
+    #   # ╞═════╪══════╪═════╪═════╡
+    #   # │ 1   ┆ 4    ┆ x   ┆ 5   │
+    #   # │ 8   ┆ 5    ┆ y   ┆ 13  │
+    #   # │ 3   ┆ null ┆ z   ┆ 3   │
+    #   # └─────┴──────┴─────┴─────┘
+    def sum_horizontal(*exprs)
+      rbexprs = Utils.parse_as_list_of_expressions(*exprs)
+      Utils.wrap_expr(Plr.sum_horizontal(rbexprs))
+    end
+
+    # Compute the mean of all values horizontally across columns.
+    #
+    # @param exprs [Array]
+    #   Column(s) to use in the aggregation. Accepts expression input. Strings are
+    #   parsed as column names, other non-expression inputs are parsed as literals.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 8, 3],
+    #       "b" => [4, 5, nil],
+    #       "c" => ["x", "y", "z"]
+    #     }
+    #   )
+    #   df.with_columns(mean: Polars.mean_horizontal("a", "b"))
+    #   # =>
+    #   # shape: (3, 4)
+    #   # ┌─────┬──────┬─────┬──────┐
+    #   # │ a   ┆ b    ┆ c   ┆ mean │
+    #   # │ --- ┆ ---  ┆ --- ┆ ---  │
+    #   # │ i64 ┆ i64  ┆ str ┆ f64  │
+    #   # ╞═════╪══════╪═════╪══════╡
+    #   # │ 1   ┆ 4    ┆ x   ┆ 2.5  │
+    #   # │ 8   ┆ 5    ┆ y   ┆ 6.5  │
+    #   # │ 3   ┆ null ┆ z   ┆ 3.0  │
+    #   # └─────┴──────┴─────┴──────┘
+    def mean_horizontal(*exprs)
+      rbexprs = Utils.parse_as_list_of_expressions(*exprs)
+      Utils.wrap_expr(Plr.mean_horizontal(rbexprs))
+    end
+
+    # Cumulatively sum all values horizontally across columns.
+    #
+    # @param exprs [Array]
+    #   Column(s) to use in the aggregation. Accepts expression input. Strings are
+    #   parsed as column names, other non-expression inputs are parsed as literals.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 8, 3],
+    #       "b" => [4, 5, nil],
+    #       "c" => ["x", "y", "z"]
+    #     }
+    #   )
+    #   df.with_columns(Polars.cum_sum_horizontal("a", "b"))
+    #   # =>
+    #   # shape: (3, 4)
+    #   # ┌─────┬──────┬─────┬───────────┐
+    #   # │ a   ┆ b    ┆ c   ┆ cum_sum   │
+    #   # │ --- ┆ ---  ┆ --- ┆ ---       │
+    #   # │ i64 ┆ i64  ┆ str ┆ struct[2] │
+    #   # ╞═════╪══════╪═════╪═══════════╡
+    #   # │ 1   ┆ 4    ┆ x   ┆ {1,5}     │
+    #   # │ 8   ┆ 5    ┆ y   ┆ {8,13}    │
+    #   # │ 3   ┆ null ┆ z   ┆ {3,null}  │
+    #   # └─────┴──────┴─────┴───────────┘
+    def cum_sum_horizontal(*exprs)
+      rbexprs = Utils.parse_as_list_of_expressions(*exprs)
+      exprs_wrapped = rbexprs.map { |e| Utils.wrap_expr(e) }
+
+      # (Expr): use u32 as that will not cast to float as eagerly
+      Polars.cum_fold(Polars.lit(0).cast(UInt32), -> (a, b) { a + b }, exprs_wrapped).alias(
+        "cum_sum"
+      )
+    end
+    alias_method :cumsum_horizontal, :cum_sum_horizontal
+  end
+end

data/lib/polars/functions/aggregation/vertical.rb

@@ -0,0 +1,282 @@
+module Polars
+  module Functions
+    # Either return an expression representing all columns, or evaluate a bitwise AND operation.
+    #
+    # If no arguments are passed, this function is syntactic sugar for `col("*")`.
+    # Otherwise, this function is syntactic sugar for `col(names).all`.
+    #
+    # @param names [Array]
+    #   Name(s) of the columns to use in the aggregation.
+    # @param ignore_nulls [Boolean]
+    #   Ignore null values (default).
+    #
+    # @return [Expr]
+    #
+    # @example Selecting all columns.
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [true, false, true],
+    #       "b" => [false, false, false]
+    #     }
+    #   )
+    #   df.select(Polars.all.sum)
+    #   # =>
+    #   # shape: (1, 2)
+    #   # ┌─────┬─────┐
+    #   # │ a   ┆ b   │
+    #   # │ --- ┆ --- │
+    #   # │ u32 ┆ u32 │
+    #   # ╞═════╪═════╡
+    #   # │ 2   ┆ 0   │
+    #   # └─────┴─────┘
+    #
+    # @example Evaluate bitwise AND for a column.
+    #   df.select(Polars.all("a"))
+    #   # =>
+    #   # shape: (1, 1)
+    #   # ┌───────┐
+    #   # │ a     │
+    #   # │ ---   │
+    #   # │ bool  │
+    #   # ╞═══════╡
+    #   # │ false │
+    #   # └───────┘
+    def all(*names, ignore_nulls: true)
+      if names.empty?
+        return col("*")
+      end
+
+      col(*names).all(drop_nulls: ignore_nulls)
+    end
+
+    # Evaluate a bitwise OR operation.
+    #
+    # Syntactic sugar for `col(names).any`.
+    #
+    # @param names [Array]
+    #   Name(s) of the columns to use in the aggregation.
+    # @param ignore_nulls [Boolean]
+    #   Ignore null values (default).
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [true, false, true],
+    #       "b" => [false, false, false]
+    #     }
+    #   )
+    #   df.select(Polars.any("a"))
+    #   # =>
+    #   # shape: (1, 1)
+    #   # ┌──────┐
+    #   # │ a    │
+    #   # │ ---  │
+    #   # │ bool │
+    #   # ╞══════╡
+    #   # │ true │
+    #   # └──────┘
+    def any(*names, ignore_nulls: true)
+      col(*names).any(drop_nulls: ignore_nulls)
+    end
+
+    # Get the maximum value.
+    #
+    # Syntactic sugar for `col(names).max`.
+    #
+    # @param names [Array]
+    #   Name(s) of the columns to use in the aggregation.
+    #
+    # @return [Expr]
+    #
+    # @example Get the maximum value of a column.
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 8, 3],
+    #       "b" => [4, 5, 2],
+    #       "c" => ["foo", "bar", "foo"]
+    #     }
+    #   )
+    #   df.select(Polars.max("a"))
+    #   # =>
+    #   # shape: (1, 1)
+    #   # ┌─────┐
+    #   # │ a   │
+    #   # │ --- │
+    #   # │ i64 │
+    #   # ╞═════╡
+    #   # │ 8   │
+    #   # └─────┘
+    #
+    # @example Get the maximum value of multiple columns.
+    #   df.select(Polars.max("^a|b$"))
+    #   # =>
+    #   # shape: (1, 2)
+    #   # ┌─────┬─────┐
+    #   # │ a   ┆ b   │
+    #   # │ --- ┆ --- │
+    #   # │ i64 ┆ i64 │
+    #   # ╞═════╪═════╡
+    #   # │ 8   ┆ 5   │
+    #   # └─────┴─────┘
+    #
+    # @example
+    #   df.select(Polars.max("a", "b"))
+    #   # =>
+    #   # shape: (1, 2)
+    #   # ┌─────┬─────┐
+    #   # │ a   ┆ b   │
+    #   # │ --- ┆ --- │
+    #   # │ i64 ┆ i64 │
+    #   # ╞═════╪═════╡
+    #   # │ 8   ┆ 5   │
+    #   # └─────┴─────┘
+    def max(*names)
+      col(*names).max
+    end
+
+    # Get the minimum value.
+    #
+    # Syntactic sugar for `col(names).min`.
+    #
+    # @param names [Array]
+    #   Name(s) of the columns to use in the aggregation.
+    #
+    # @return [Expr]
+    #
+    # @example Get the minimum value of a column.
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 8, 3],
+    #       "b" => [4, 5, 2],
+    #       "c" => ["foo", "bar", "foo"]
+    #     }
+    #   )
+    #   df.select(Polars.min("a"))
+    #   # =>
+    #   # shape: (1, 1)
+    #   # ┌─────┐
+    #   # │ a   │
+    #   # │ --- │
+    #   # │ i64 │
+    #   # ╞═════╡
+    #   # │ 1   │
+    #   # └─────┘
+    #
+    # @example Get the minimum value of multiple columns.
+    #   df.select(Polars.min("^a|b$"))
+    #   # =>
+    #   # shape: (1, 2)
+    #   # ┌─────┬─────┐
+    #   # │ a   ┆ b   │
+    #   # │ --- ┆ --- │
+    #   # │ i64 ┆ i64 │
+    #   # ╞═════╪═════╡
+    #   # │ 1   ┆ 2   │
+    #   # └─────┴─────┘
+    #
+    # @example
+    #   df.select(Polars.min("a", "b"))
+    #   # =>
+    #   # shape: (1, 2)
+    #   # ┌─────┬─────┐
+    #   # │ a   ┆ b   │
+    #   # │ --- ┆ --- │
+    #   # │ i64 ┆ i64 │
+    #   # ╞═════╪═════╡
+    #   # │ 1   ┆ 2   │
+    #   # └─────┴─────┘
+    def min(*names)
+      col(*names).min
+    end
+
+    # Sum all values.
+    #
+    # Syntactic sugar for `col(name).sum`.
+    #
+    # @param names [Array]
+    #   Name(s) of the columns to use in the aggregation.
+    #
+    # @return [Expr]
+    #
+    # @example Sum a column.
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 2],
+    #       "b" => [3, 4],
+    #       "c" => [5, 6]
+    #     }
+    #   )
+    #   df.select(Polars.sum("a"))
+    #   # =>
+    #   # shape: (1, 1)
+    #   # ┌─────┐
+    #   # │ a   │
+    #   # │ --- │
+    #   # │ i64 │
+    #   # ╞═════╡
+    #   # │ 3   │
+    #   # └─────┘
+    #
+    # @example Sum multiple columns.
+    #   df.select(Polars.sum("a", "c"))
+    #   # =>
+    #   # shape: (1, 2)
+    #   # ┌─────┬─────┐
+    #   # │ a   ┆ c   │
+    #   # │ --- ┆ --- │
+    #   # │ i64 ┆ i64 │
+    #   # ╞═════╪═════╡
+    #   # │ 3   ┆ 11  │
+    #   # └─────┴─────┘
+    #
+    # @example
+    #   df.select(Polars.sum("^.*[bc]$"))
+    #   # =>
+    #   # shape: (1, 2)
+    #   # ┌─────┬─────┐
+    #   # │ b   ┆ c   │
+    #   # │ --- ┆ --- │
+    #   # │ i64 ┆ i64 │
+    #   # ╞═════╪═════╡
+    #   # │ 7   ┆ 11  │
+    #   # └─────┴─────┘
+    def sum(*names)
+      col(*names).sum
+    end
+
+    # Cumulatively sum all values.
+    #
+    # Syntactic sugar for `col(names).cum_sum`.
+    #
+    # @param names [Object]
+    #   Name(s) of the columns to use in the aggregation.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [1, 2, 3],
+    #       "b" => [4, 5, 6]
+    #     }
+    #   )
+    #   df.select(Polars.cum_sum("a"))
+    #   # =>
+    #   # shape: (3, 1)
+    #   # ┌─────┐
+    #   # │ a   │
+    #   # │ --- │
+    #   # │ i64 │
+    #   # ╞═════╡
+    #   # │ 1   │
+    #   # │ 3   │
+    #   # │ 6   │
+    #   # └─────┘
+    def cum_sum(*names)
+      col(*names).cum_sum
+    end
+    alias_method :cumsum, :cum_sum
+  end
+end