expr.rb in polars-df-0.1.2

- old
+ new

@@ -1,9 +1,12 @@
 module Polars
+  # Expressions that can be used in various contexts.
   class Expr
+    # @private
     attr_accessor :_rbexpr
 
+    # @private
     def self._from_rbexpr(rbexpr)
       expr = Expr.allocate
       expr._rbexpr = rbexpr
       expr
     end
@@ -78,10 +81,11 @@
     end
 
     # def to_physical
     # end
 
+    #
     def any
       wrap_expr(_rbexpr.any)
     end
 
     def all
@@ -102,11 +106,13 @@
 
     def alias(name)
       wrap_expr(_rbexpr._alias(name))
     end
 
-    # TODO support symbols
+    # TODO support symbols for exclude
+
+    #
     def exclude(columns)
       if columns.is_a?(String)
         columns = [columns]
         return wrap_expr(_rbexpr.exclude(columns))
       elsif !columns.is_a?(Array)
@@ -138,10 +144,11 @@
     end
 
     # def map_alias
     # end
 
+    #
     def is_not
       wrap_expr(_rbexpr.is_not)
     end
 
     def is_null
@@ -291,11 +298,12 @@
     end
 
     # def take
     # end
 
-    def shift(periods)
+    #
+    def shift(periods = 1)
       wrap_expr(_rbexpr.shift(periods))
     end
 
     def shift_and_fill(periods, fill_value)
       fill_value = Utils.expr_to_lit_or_expr(fill_value, str_to_lit: true)
@@ -437,10 +445,11 @@
     # end
 
     # def apply
     # end
 
+    #
     def flatten
       wrap_expr(_rbexpr.explode)
     end
 
     def explode
@@ -469,10 +478,11 @@
     end
 
     # def is_in
     # end
 
+    #
     def repeat_by(by)
       by = Utils.expr_to_lit_or_expr(by, false)
       wrap_expr(_rbexpr.repeat_by(by._rbexpr))
     end
 
@@ -480,17 +490,19 @@
     # end
 
     # def _hash
     # end
 
+    #
     def reinterpret(signed: false)
       wrap_expr(_rbexpr.reinterpret(signed))
     end
 
     # def _inspect
     # end
 
+    #
     def interpolate
       wrap_expr(_rbexpr.interpolate)
     end
 
     # def rolling_min
@@ -518,10 +530,11 @@
     # end
 
     # def rolling_apply
     # end
 
+    #
     def rolling_skew(window_size, bias: true)
       wrap_expr(_rbexpr.rolling_skew(window_size, bias))
     end
 
     def abs
@@ -648,10 +661,11 @@
     # end
 
     # def extend_constant
     # end
 
+    #
     def value_counts(multithreaded: false, sort: false)
       wrap_expr(_rbexpr.value_counts(multithreaded, sort))
     end
 
     def unique_counts
@@ -670,9 +684,10 @@
     # end
 
     # def set_sorted
     # end
 
+    #
     def list
       wrap_expr(_rbexpr.list)
     end
 
     def shrink_dtype