Class: Polars::CatNameSpace

Inherits:
Object
  • Object
show all
Defined in:
lib/polars/cat_name_space.rb

Overview

Series.cat namespace.

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Polars::ExprDispatch

Instance Method Details

#get_categories ⇒ Series

Get the categories stored in this data type.

Examples:

s = Polars::Series.new(["foo", "bar", "foo", "foo", "ham"], dtype: Polars::Categorical)
s.cat.get_categories
# =>
# shape: (3,)
# Series: '' [str]
# [
#         "foo"
#         "bar"
#         "ham"
# ]

Returns:



28
29
30
 
# File 'lib/polars/cat_name_space.rb', line 28

def get_categories
  super
end

#is_local ⇒ Boolean

Return whether or not the column is a local categorical.

Examples:

Categoricals constructed without a string cache are considered local.

s = Polars::Series.new(["a", "b", "a"], dtype: Polars::Categorical)
s.cat.is_local
# => true

Categoricals constructed with a string cache are considered global.

s = nil
Polars::StringCache.new do
  s = Polars::Series.new(["a", "b", "a"], dtype: Polars::Categorical)
end
s.cat.is_local
# => false

Returns:



48
49
50
 
# File 'lib/polars/cat_name_space.rb', line 48

def is_local
  _s.cat_is_local
end

#to_local ⇒ Series

Convert a categorical column to its local representation.

This may change the underlying physical representation of the column.

Examples:

Compare the global and local representations of a categorical.

s = nil
Polars::StringCache.new do
  _ = Polars::Series.new("x", ["a", "b", "a"], dtype: Polars::Categorical)
  s = Polars::Series.new("y", ["c", "b", "d"], dtype: Polars::Categorical)
end
s.to_physical
# =>
# shape: (3,)
# Series: 'y' [u32]
# [
#         2
#         1
#         3
# ]
s.cat.to_local.to_physical
# =>
# shape: (3,)
# Series: 'y' [u32]
# [
#         0
#         1
#         2
# ]

Returns:



84
85
86
 
# File 'lib/polars/cat_name_space.rb', line 84

def to_local
  Utils.wrap_s(_s.cat_to_local)
end