Sha256: 34ae14c152258e59f58f85c29b7c3e07cce783aa50227adf3230389d75678d33

Contents?: true

Size: 1.56 KB

Versions: 32

Compression:

Stored size: 1.56 KB

Contents

module Polars
  # Series.cat namespace.
  class CatNameSpace
    include ExprDispatch

    self._accessor = "cat"

    # @private
    def initialize(series)
      self._s = series._s
    end

    # Determine how this categorical series should be sorted.
    #
    # @param ordering ["physical", "lexical"]
    #   Ordering type:
    #
    #   - 'physical' -> Use the physical representation of the categories to
    #       determine the order (default).
    #   - 'lexical' -> Use the string values to determine the ordering.
    #
    # @return [Series]
    #
    # @example
    #   df = Polars::DataFrame.new(
    #     {"cats" => ["z", "z", "k", "a", "b"], "vals" => [3, 1, 2, 2, 3]}
    #   ).with_columns(
    #     [
    #       Polars.col("cats").cast(:cat).cat.set_ordering("lexical")
    #     ]
    #   )
    #   df.sort(["cats", "vals"])
    #   # =>
    #   # shape: (5, 2)
    #   # ┌──────┬──────┐
    #   # │ cats ┆ vals │
    #   # │ ---  ┆ ---  │
    #   # │ cat  ┆ i64  │
    #   # ╞══════╪══════╡
    #   # │ a    ┆ 2    │
    #   # ├╌╌╌╌╌╌┼╌╌╌╌╌╌┤
    #   # │ b    ┆ 3    │
    #   # ├╌╌╌╌╌╌┼╌╌╌╌╌╌┤
    #   # │ k    ┆ 2    │
    #   # ├╌╌╌╌╌╌┼╌╌╌╌╌╌┤
    #   # │ z    ┆ 1    │
    #   # ├╌╌╌╌╌╌┼╌╌╌╌╌╌┤
    #   # │ z    ┆ 3    │
    #   # └──────┴──────┘
    def set_ordering(ordering)
      super
    end
  end
end

Version data entries

32 entries across 32 versions & 1 rubygems

Version Path
polars-df-0.2.1-x86_64-linux lib/polars/cat_name_space.rb
polars-df-0.2.1-x86_64-darwin lib/polars/cat_name_space.rb
polars-df-0.2.1-arm64-darwin lib/polars/cat_name_space.rb
polars-df-0.2.1-aarch64-linux lib/polars/cat_name_space.rb
polars-df-0.2.1 lib/polars/cat_name_space.rb
polars-df-0.2.0-x86_64-linux lib/polars/cat_name_space.rb
polars-df-0.2.0-x86_64-darwin lib/polars/cat_name_space.rb
polars-df-0.2.0-arm64-darwin lib/polars/cat_name_space.rb
polars-df-0.2.0-aarch64-linux lib/polars/cat_name_space.rb
polars-df-0.2.0 lib/polars/cat_name_space.rb
polars-df-0.1.5 lib/polars/cat_name_space.rb
polars-df-0.1.4 lib/polars/cat_name_space.rb