polars-df 0.21.0 → 0.21.1

data/lib/polars/cat_name_space.rb

@@ -44,5 +44,143 @@ module Polars
     def to_local
       Utils.wrap_s(_s.cat_to_local)
     end
+
+    # Indicate whether the Series uses lexical ordering.
+    #
+    # @note
+    #   This functionality is considered **unstable**. It may be changed
+    #   at any point without it being considered a breaking change.
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   s = Polars::Series.new(["b", "a", "b"]).cast(Polars::Categorical)
+    #   s.cat.uses_lexical_ordering
+    #   # => true
+    def uses_lexical_ordering
+      _s.cat_uses_lexical_ordering
+    end
+
+    # Return the byte-length of the string representation of each value.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new(["Café", "345", "東京", nil], dtype: Polars::Categorical)
+    #   s.cat.len_bytes
+    #   # =>
+    #   # shape: (4,)
+    #   # Series: '' [u32]
+    #   # [
+    #   #         5
+    #   #         3
+    #   #         6
+    #   #         null
+    #   # ]
+    def len_bytes
+      super
+    end
+
+    # Return the number of characters of the string representation of each value.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new(["Café", "345", "東京", nil], dtype: Polars::Categorical)
+    #   s.cat.len_chars
+    #   # =>
+    #   # shape: (4,)
+    #   # Series: '' [u32]
+    #   # [
+    #   #         4
+    #   #         3
+    #   #         2
+    #   #         null
+    #   # ]
+    def len_chars
+      super
+    end
+
+    # Check if string representations of values start with a substring.
+    #
+    # @param prefix [String]
+    #     Prefix substring.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new("fruits", ["apple", "mango", nil], dtype: Polars::Categorical)
+    #   s.cat.starts_with("app")
+    #   # =>
+    #   # shape: (3,)
+    #   # Series: 'fruits' [bool]
+    #   # [
+    #   #         true
+    #   #         false
+    #   #         null
+    #   # ]
+    def starts_with(prefix)
+      super
+    end
+
+    # Check if string representations of values end with a substring.
+    #
+    # @param suffix [String]
+    #   Suffix substring.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new("fruits", ["apple", "mango", nil], dtype: Polars::Categorical)
+    #   s.cat.ends_with("go")
+    #   # =>
+    #   # shape: (3,)
+    #   # Series: 'fruits' [bool]
+    #   # [
+    #   #         false
+    #   #         true
+    #   #         null
+    #   # ]
+    def ends_with(suffix)
+      super
+    end
+
+    # Extract a substring from the string representation of each string value.
+    #
+    # @param offset [Integer]
+    #   Start index. Negative indexing is supported.
+    # @param length [Integer]
+    #   Length of the slice. If set to `nil` (default), the slice is taken to the
+    #   end of the string.
+    #
+    # @return [Series]
+    #
+    # @example
+    #   s = Polars::Series.new(["pear", nil, "papaya", "dragonfruit"], dtype: Polars::Categorical)
+    #   s.cat.slice(-3)
+    #   # =>
+    #   # shape: (4,)
+    #   # Series: '' [str]
+    #   # [
+    #   #         "ear"
+    #   #         null
+    #   #         "aya"
+    #   #         "uit"
+    #   # ]
+    #
+    # @example Using the optional `length` parameter
+    #   s.cat.slice(4, 3)
+    #   # =>
+    #   # shape: (4,)
+    #   # Series: '' [str]
+    #   # [
+    #   #         ""
+    #   #         null
+    #   #         "ya"
+    #   #         "onf"
+    #   # ]
+    def slice(offset, length = nil)
+      super
+    end
   end
 end

data/lib/polars/config.rb

@@ -80,11 +80,11 @@ module Polars
       options
     end
 
-    # Show the current state of all Config variables as a dict.
+    # Show the current state of all Config variables as a hash.
     #
     # @param if_set [Boolean]
     #   by default this will show the state of all `Config` environment variables.
-    #   change this to `true` to restrict the returned dictionary to include only
+    #   change this to `true` to restrict the returned hash to include only
     #   those that have been set to a specific value.
     # @param env_only [Boolean]
     #   include only Config environment variables in the output; some options (such

data/lib/polars/convert.rb

@@ -1,6 +1,6 @@
 module Polars
   module Convert
-    # Construct a DataFrame from a dictionary of sequences.
+    # Construct a DataFrame from a hash of arrays.
     #
     # This operation clones data, unless you pass in a `Hash<String, Series>`.
     #
@@ -10,11 +10,11 @@ module Polars
     # @param schema [Object]
     #   The DataFrame schema may be declared in several ways:
     #
-    #   * As a dict of {name:type} pairs; if type is None, it will be auto-inferred.
-    #   * As a list of column names; in this case types are automatically inferred.
-    #   * As a list of (name,type) pairs; this is equivalent to the dictionary form.
+    #   * As a hash of \\\\{name:type} pairs; if type is nil, it will be auto-inferred.
+    #   * As an array of column names; in this case types are automatically inferred.
+    #   * As an array of [name,type] pairs; this is equivalent to the hash form.
     #
-    #   If you supply a list of column names that does not match the names in the
+    #   If you supply an array of column names that does not match the names in the
     #   underlying data, the names given here will overwrite them. The number
     #   of names given in the schema should match the underlying data dimensions.
     # @param columns [Array]
@@ -45,7 +45,7 @@ module Polars
       )
     end
 
-    # Construct a DataFrame from a sequence of dictionaries. This operation clones data.
+    # Construct a DataFrame from an array of hashes. This operation clones data.
     #
     # @param hashes [Array]
     #   Array with hashes mapping column name to value.