polars-df 0.20.0-x64-mingw-ucrt → 0.21.1-x64-mingw-ucrt

data/lib/polars/list_expr.rb

@@ -80,10 +80,10 @@ module Polars
     #   # │ 2   │
     #   # │ 1   │
     #   # └─────┘
-    def lengths
+    def len
       Utils.wrap_expr(_rbexpr.list_len)
     end
-    alias_method :len, :lengths
+    alias_method :lengths, :len
 
     # Drop all null values in the list.
     #
@@ -136,7 +136,7 @@ module Polars
     #   # │ ---       ┆ --- ┆ ---       │
     #   # │ list[i64] ┆ i64 ┆ list[i64] │
     #   # ╞═══════════╪═════╪═══════════╡
-    #   # │ [1, 2, 3] ┆ 2   ┆ [2, 1]    │
+    #   # │ [1, 2, 3] ┆ 2   ┆ [2, 3]    │
     #   # │ [4, 5]    ┆ 1   ┆ [5]       │
     #   # └───────────┴─────┴───────────┘
     def sample(n: nil, fraction: nil, with_replacement: false, shuffle: false, seed: nil)
@@ -243,6 +243,79 @@ module Polars
       Utils.wrap_expr(_rbexpr.list_mean)
     end
 
+    # Compute the median value of the lists in the array.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new({"values" => [[-1, 0, 1], [1, 10]]})
+    #   df.with_columns(Polars.col("values").list.median.alias("median"))
+    #   # =>
+    #   # shape: (2, 2)
+    #   # ┌────────────┬────────┐
+    #   # │ values     ┆ median │
+    #   # │ ---        ┆ ---    │
+    #   # │ list[i64]  ┆ f64    │
+    #   # ╞════════════╪════════╡
+    #   # │ [-1, 0, 1] ┆ 0.0    │
+    #   # │ [1, 10]    ┆ 5.5    │
+    #   # └────────────┴────────┘
+    def median
+      Utils.wrap_expr(_rbexpr.list_median)
+    end
+
+    # Compute the std value of the lists in the array.
+    #
+    # @param ddof [Integer]
+    #   “Delta Degrees of Freedom”: the divisor used in the calculation is N - ddof,
+    #   where N represents the number of elements.
+    #   By default ddof is 1.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new({"values" => [[-1, 0, 1], [1, 10]]})
+    #   df.with_columns(Polars.col("values").list.std.alias("std"))
+    #   # =>
+    #   # shape: (2, 2)
+    #   # ┌────────────┬──────────┐
+    #   # │ values     ┆ std      │
+    #   # │ ---        ┆ ---      │
+    #   # │ list[i64]  ┆ f64      │
+    #   # ╞════════════╪══════════╡
+    #   # │ [-1, 0, 1] ┆ 1.0      │
+    #   # │ [1, 10]    ┆ 6.363961 │
+    #   # └────────────┴──────────┘
+    def std(ddof: 1)
+      Utils.wrap_expr(_rbexpr.list_std(ddof))
+    end
+
+    # Compute the var value of the lists in the array.
+    #
+    # @param ddof [Integer]
+    #   “Delta Degrees of Freedom”: the divisor used in the calculation is N - ddof,
+    #   where N represents the number of elements.
+    #   By default ddof is 1.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new({"values" => [[-1, 0, 1], [1, 10]]})
+    #   df.with_columns(Polars.col("values").list.var.alias("var"))
+    #   # =>
+    #   # shape: (2, 2)
+    #   # ┌────────────┬──────┐
+    #   # │ values     ┆ var  │
+    #   # │ ---        ┆ ---  │
+    #   # │ list[i64]  ┆ f64  │
+    #   # ╞════════════╪══════╡
+    #   # │ [-1, 0, 1] ┆ 1.0  │
+    #   # │ [1, 10]    ┆ 40.5 │
+    #   # └────────────┴──────┘
+    def var(ddof: 1)
+      Utils.wrap_expr(_rbexpr.list_var(ddof))
+    end
+
     # Sort the arrays in the list.
     #
     # @param reverse [Boolean]
@@ -322,6 +395,31 @@ module Polars
       Utils.wrap_expr(_rbexpr.list_unique(maintain_order))
     end
 
+    # Count the number of unique values in every sub-lists.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [[1, 1, 2], [2, 3, 4]]
+    #     }
+    #   )
+    #   df.with_columns(n_unique: Polars.col("a").list.n_unique)
+    #   # =>
+    #   # shape: (2, 2)
+    #   # ┌───────────┬──────────┐
+    #   # │ a         ┆ n_unique │
+    #   # │ ---       ┆ ---      │
+    #   # │ list[i64] ┆ u32      │
+    #   # ╞═══════════╪══════════╡
+    #   # │ [1, 1, 2] ┆ 2        │
+    #   # │ [2, 3, 4] ┆ 3        │
+    #   # └───────────┴──────────┘
+    def n_unique
+      Utils.wrap_expr(_rbexpr.list_n_unique)
+    end
+
     # Concat the arrays in a Series dtype List in linear time.
     #
     # @param other [Object]
@@ -366,7 +464,7 @@ module Polars
     #
     # So index `0` would return the first item of every sublist
     # and index `-1` would return the last item of every sublist
-    # if an index is out of bounds, it will return a `None`.
+    # if an index is out of bounds, it will return a `nil`.
     #
     # @param index [Integer]
     #   Index to return per sublist
@@ -438,6 +536,48 @@ module Polars
     end
     alias_method :take, :gather
 
+    # Take every n-th value start from offset in sublists.
+    #
+    # @param n [Integer]
+    #   Gather every n-th element.
+    # @param offset [Integer]
+    #   Starting index.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [[1, 2, 3, 4, 5], [6, 7, 8], [9, 10, 11, 12]],
+    #       "n" => [2, 1, 3],
+    #       "offset" => [0, 1, 0]
+    #     }
+    #   )
+    #   df.with_columns(
+    #     gather_every: Polars.col("a").list.gather_every(
+    #       Polars.col("n"), Polars.col("offset")
+    #     )
+    #   )
+    #   # =>
+    #   # shape: (3, 4)
+    #   # ┌───────────────┬─────┬────────┬──────────────┐
+    #   # │ a             ┆ n   ┆ offset ┆ gather_every │
+    #   # │ ---           ┆ --- ┆ ---    ┆ ---          │
+    #   # │ list[i64]     ┆ i64 ┆ i64    ┆ list[i64]    │
+    #   # ╞═══════════════╪═════╪════════╪══════════════╡
+    #   # │ [1, 2, … 5]   ┆ 2   ┆ 0      ┆ [1, 3, 5]    │
+    #   # │ [6, 7, 8]     ┆ 1   ┆ 1      ┆ [7, 8]       │
+    #   # │ [9, 10, … 12] ┆ 3   ┆ 0      ┆ [9, 12]      │
+    #   # └───────────────┴─────┴────────┴──────────────┘
+    def gather_every(
+      n,
+      offset = 0
+    )
+      n = Utils.parse_into_expression(n)
+      offset = Utils.parse_into_expression(offset)
+      Utils.wrap_expr(_rbexpr.list_gather_every(n, offset))
+    end
+
     # Get the first value of the sublists.
     #
     # @return [Expr]
@@ -702,7 +842,32 @@ module Polars
       Utils.wrap_expr(_rbexpr.list_tail(n))
     end
 
-    # Count how often the value produced by ``element`` occurs.
+    # Returns a column with a separate row for every list element.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new({"a" => [[1, 2, 3], [4, 5, 6]]})
+    #   df.select(Polars.col("a").list.explode)
+    #   # =>
+    #   # shape: (6, 1)
+    #   # ┌─────┐
+    #   # │ a   │
+    #   # │ --- │
+    #   # │ i64 │
+    #   # ╞═════╡
+    #   # │ 1   │
+    #   # │ 2   │
+    #   # │ 3   │
+    #   # │ 4   │
+    #   # │ 5   │
+    #   # │ 6   │
+    #   # └─────┘
+    def explode
+      Utils.wrap_expr(_rbexpr.explode)
+    end
+
+    # Count how often the value produced by `element` occurs.
     #
     # @param element [Expr]
     #   An expression that produces a single value
@@ -730,13 +895,52 @@ module Polars
     end
     alias_method :count_match, :count_matches
 
+    # Convert a List column into an Array column with the same inner data type.
+    #
+    # @param width [Integer]
+    #   Width of the resulting Array column.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {"a" => [[1, 2], [3, 4]]},
+    #     schema: {"a" => Polars::List.new(Polars::Int8)}
+    #   )
+    #   df.with_columns(array: Polars.col("a").list.to_array(2))
+    #   # =>
+    #   # shape: (2, 2)
+    #   # ┌──────────┬──────────────┐
+    #   # │ a        ┆ array        │
+    #   # │ ---      ┆ ---          │
+    #   # │ list[i8] ┆ array[i8, 2] │
+    #   # ╞══════════╪══════════════╡
+    #   # │ [1, 2]   ┆ [1, 2]       │
+    #   # │ [3, 4]   ┆ [3, 4]       │
+    #   # └──────────┴──────────────┘
+    def to_array(width)
+      Utils.wrap_expr(_rbexpr.list_to_array(width))
+    end
+
     # Convert the series of type `List` to a series of type `Struct`.
     #
     # @param n_field_strategy ["first_non_null", "max_width"]
     #   Strategy to determine the number of fields of the struct.
-    # @param name_generator [Object]
-    #   A custom function that can be used to generate the field names.
-    #   Default field names are `field_0, field_1 .. field_n`
+    # @param fields pArray
+    #   If the name and number of the desired fields is known in advance
+    #   a list of field names can be given, which will be assigned by index.
+    #   Otherwise, to dynamically assign field names, a custom function can be
+    #   used; if neither are set, fields will be `field_0, field_1 .. field_n`.
+    # @param upper_bound [Object]
+    #   A polars `LazyFrame` needs to know the schema at all times, so the
+    #   caller must provide an upper bound of the number of struct fields that
+    #   will be created; if set incorrectly, subsequent operations may fail.
+    #   (For example, an `all.sum` expression will look in the current
+    #   schema to determine which columns to select).
+    #
+    #   When operating on a `DataFrame`, the schema does not need to be
+    #   tracked or pre-determined, as the result will be eagerly evaluated,
+    #   so you can leave this parameter unset.
     #
     # @return [Expr]
     #
@@ -753,9 +957,8 @@ module Polars
     #   # │ {1,2,3}    │
     #   # │ {1,2,null} │
     #   # └────────────┘
-    def to_struct(n_field_strategy: "first_non_null", name_generator: nil, upper_bound: nil)
-      raise Todo if name_generator
-      Utils.wrap_expr(_rbexpr.list_to_struct(n_field_strategy, name_generator, nil))
+    def to_struct(n_field_strategy: "first_non_null", fields: nil, upper_bound: nil)
+      Utils.wrap_expr(_rbexpr.list_to_struct(n_field_strategy, fields, nil))
     end
 
     # Run any polars expression against the lists' elements.
@@ -785,5 +988,191 @@ module Polars
     def eval(expr)
       Utils.wrap_expr(_rbexpr.list_eval(expr._rbexpr))
     end
+
+    # Filter elements in each list by a boolean expression.
+    #
+    # @param predicate [Object]
+    #   A boolean expression that is evaluated per list element.
+    #   You can refer to the current element with `Polars.element`.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new({"a" => [1, 8, 3], "b" => [4, 5, 2]})
+    #   df.with_columns(
+    #     evens: Polars.concat_list("a", "b").list.filter(Polars.element % 2 == 0)
+    #   )
+    #   # =>
+    #   # shape: (3, 3)
+    #   # ┌─────┬─────┬───────────┐
+    #   # │ a   ┆ b   ┆ evens     │
+    #   # │ --- ┆ --- ┆ ---       │
+    #   # │ i64 ┆ i64 ┆ list[i64] │
+    #   # ╞═════╪═════╪═══════════╡
+    #   # │ 1   ┆ 4   ┆ [4]       │
+    #   # │ 8   ┆ 5   ┆ [8]       │
+    #   # │ 3   ┆ 2   ┆ [2]       │
+    #   # └─────┴─────┴───────────┘
+    def filter(predicate)
+      Utils.wrap_expr(_rbexpr.list_filter(predicate._rbexpr))
+    end
+
+    # Compute the SET UNION between the elements in this list and the elements of `other`.
+    #
+    # @param other [Object]
+    #   Right hand side of the set operation.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [[1, 2, 3], [], [nil, 3], [5, 6, 7]],
+    #       "b" => [[2, 3, 4], [3], [3, 4, nil], [6, 8]]
+    #     }
+    #   )
+    #   df.with_columns(
+    #     union: Polars.col("a").list.set_union("b")
+    #   )
+    #   # =>
+    #   # shape: (4, 3)
+    #   # ┌───────────┬──────────────┬──────────────┐
+    #   # │ a         ┆ b            ┆ union        │
+    #   # │ ---       ┆ ---          ┆ ---          │
+    #   # │ list[i64] ┆ list[i64]    ┆ list[i64]    │
+    #   # ╞═══════════╪══════════════╪══════════════╡
+    #   # │ [1, 2, 3] ┆ [2, 3, 4]    ┆ [1, 2, … 4]  │
+    #   # │ []        ┆ [3]          ┆ [3]          │
+    #   # │ [null, 3] ┆ [3, 4, null] ┆ [null, 3, 4] │
+    #   # │ [5, 6, 7] ┆ [6, 8]       ┆ [5, 6, … 8]  │
+    #   # └───────────┴──────────────┴──────────────┘
+    def set_union(other)
+      if other.respond_to?(:each)
+        if !other.is_a?(::Array) && !other.is_a?(Series) && !other.is_a?(DataFrame)
+          other = other.to_a
+        end
+        other = F.lit(other)._rbexpr
+      else
+        other = Utils.parse_into_expression(other)
+      end
+      Utils.wrap_expr(_rbexpr.list_set_operation(other, "union"))
+    end
+
+    # Compute the SET DIFFERENCE between the elements in this list and the elements of `other`.
+    #
+    # @param other [Object]
+    #   Right hand side of the set operation.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [[1, 2, 3], [], [nil, 3], [5, 6, 7]],
+    #       "b" => [[2, 3, 4], [3], [3, 4, nil], [6, 8]]
+    #     }
+    #   )
+    #   df.with_columns(difference: Polars.col("a").list.set_difference("b"))
+    #   # =>
+    #   # shape: (4, 3)
+    #   # ┌───────────┬──────────────┬────────────┐
+    #   # │ a         ┆ b            ┆ difference │
+    #   # │ ---       ┆ ---          ┆ ---        │
+    #   # │ list[i64] ┆ list[i64]    ┆ list[i64]  │
+    #   # ╞═══════════╪══════════════╪════════════╡
+    #   # │ [1, 2, 3] ┆ [2, 3, 4]    ┆ [1]        │
+    #   # │ []        ┆ [3]          ┆ []         │
+    #   # │ [null, 3] ┆ [3, 4, null] ┆ []         │
+    #   # │ [5, 6, 7] ┆ [6, 8]       ┆ [5, 7]     │
+    #   # └───────────┴──────────────┴────────────┘
+    def set_difference(other)
+      if other.respond_to?(:each)
+        if !other.is_a?(::Array) && !other.is_a?(Series) && !other.is_a?(DataFrame)
+          other = other.to_a
+        end
+        other = F.lit(other)._rbexpr
+      else
+        other = Utils.parse_into_expression(other)
+      end
+      Utils.wrap_expr(_rbexpr.list_set_operation(other, "difference"))
+    end
+
+    # Compute the SET INTERSECTION between the elements in this list and the elements of `other`.
+    #
+    # @param other [Object]
+    #   Right hand side of the set operation.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [[1, 2, 3], [], [nil, 3], [5, 6, 7]],
+    #       "b" => [[2, 3, 4], [3], [3, 4, nil], [6, 8]]
+    #     }
+    #   )
+    #   df.with_columns(intersection: Polars.col("a").list.set_intersection("b"))
+    #   # =>
+    #   # shape: (4, 3)
+    #   # ┌───────────┬──────────────┬──────────────┐
+    #   # │ a         ┆ b            ┆ intersection │
+    #   # │ ---       ┆ ---          ┆ ---          │
+    #   # │ list[i64] ┆ list[i64]    ┆ list[i64]    │
+    #   # ╞═══════════╪══════════════╪══════════════╡
+    #   # │ [1, 2, 3] ┆ [2, 3, 4]    ┆ [2, 3]       │
+    #   # │ []        ┆ [3]          ┆ []           │
+    #   # │ [null, 3] ┆ [3, 4, null] ┆ [null, 3]    │
+    #   # │ [5, 6, 7] ┆ [6, 8]       ┆ [6]          │
+    #   # └───────────┴──────────────┴──────────────┘
+    def set_intersection(other)
+      if other.respond_to?(:each)
+        if !other.is_a?(::Array) && !other.is_a?(Series) && !other.is_a?(DataFrame)
+          other = other.to_a
+        end
+        other = F.lit(other)._rbexpr
+      else
+        other = Utils.parse_into_expression(other)
+      end
+      Utils.wrap_expr(_rbexpr.list_set_operation(other, "intersection"))
+    end
+
+    # Compute the SET SYMMETRIC DIFFERENCE between the elements in this list and the elements of `other`.
+    #
+    # @param other [Object]
+    #   Right hand side of the set operation.
+    #
+    # @return [Expr]
+    #
+    # @example
+    #   df = Polars::DataFrame.new(
+    #     {
+    #       "a" => [[1, 2, 3], [], [nil, 3], [5, 6, 7]],
+    #       "b" => [[2, 3, 4], [3], [3, 4, nil], [6, 8]]
+    #     }
+    #   )
+    #   df.with_columns(sdiff: Polars.col("b").list.set_symmetric_difference("a"))
+    #   # =>
+    #   # shape: (4, 3)
+    #   # ┌───────────┬──────────────┬───────────┐
+    #   # │ a         ┆ b            ┆ sdiff     │
+    #   # │ ---       ┆ ---          ┆ ---       │
+    #   # │ list[i64] ┆ list[i64]    ┆ list[i64] │
+    #   # ╞═══════════╪══════════════╪═══════════╡
+    #   # │ [1, 2, 3] ┆ [2, 3, 4]    ┆ [4, 1]    │
+    #   # │ []        ┆ [3]          ┆ [3]       │
+    #   # │ [null, 3] ┆ [3, 4, null] ┆ [4]       │
+    #   # │ [5, 6, 7] ┆ [6, 8]       ┆ [8, 5, 7] │
+    #   # └───────────┴──────────────┴───────────┘
+    def set_symmetric_difference(other)
+      if other.respond_to?(:each)
+        if !other.is_a?(::Array) && !other.is_a?(Series) && !other.is_a?(DataFrame)
+          other = other.to_a
+        end
+        other = F.lit(other)._rbexpr
+      else
+        other = Utils.parse_into_expression(other)
+      end
+      Utils.wrap_expr(_rbexpr.list_set_operation(other, "symmetric_difference"))
+    end
   end
 end