df-script 1.9.0 → 2.0.0

package/dist/columnExpressions/mixins/ArithmeticExpr.d.ts

@@ -10,48 +10,75 @@ export declare class ArithmeticExpr extends ExprBase {
      * Computes the absolute value of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [-1, 2, -3.5] })
-     * >>> df.with_columns($df.col("a").abs().alias("abs_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").abs().alias("abs_a"))
      * shape: (3, 2)
-     * ┌──────┬───────┐
-     * │ a    │ abs_a │
-     * ├──────┼───────┤
-     * │ -1   │ 1     │
-     * │ 2    │ 2     │
-     * │ -3.5 │ 3.5   │
-     * └──────┴───────┘
+     * ┌───┬───────┐
+     * │ a │ abs_a │
+     * ├───┼───────┤
+     * │ 1 │ 1     │
+     * │ 2 │ 2     │
+     * │ 3 │ 3     │
+     * └───┴───────┘
      */
     abs(): this;
     /**
      * Computes the mathematical arccosine (inverse cosine) of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 0.5, 1] })
-     * >>> df.with_columns($df.col("a").acos().alias("acos_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").acos().alias("acos_a"))
      * shape: (3, 2)
-     * ┌─────┬───────────┐
-     * │ a   │ acos_a    │
-     * ├─────┼───────────┤
-     * │ 0   │ 1.570796  │
-     * │ 0.5 │ 1.047197  │
-     * │ 1   │ 0         │
-     * └─────┴───────────┘
+     * ┌───┬────────┐
+     * │ a │ acos_a │
+     * ├───┼────────┤
+     * │ 1 │ 0      │
+     * │ 2 │ null   │
+     * │ 3 │ null   │
+     * └───┴────────┘
      */
     acos(): this;
     /**
      * Computes the hyperbolic arccosine of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1, 2, 5] })
-     * >>> df.with_columns($df.col("a").acosh().alias("acosh_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").acosh().alias("acosh_a"))
      * shape: (3, 2)
-     * ┌───┬───────────┐
-     * │ a │ acosh_a   │
-     * ├───┼───────────┤
-     * │ 1 │ 0         │
-     * │ 2 │ 1.316957  │
-     * │ 5 │ 2.292431  │
-     * └───┴───────────┘
+     * ┌───┬──────────┐
+     * │ a │ acosh_a  │
+     * ├───┼──────────┤
+     * │ 1 │ 0        │
+     * │ 2 │ 1.316958 │
+     * │ 3 │ 1.762747 │
+     * └───┴──────────┘
      */
     acosh(): this;
     /**
@@ -59,8 +86,17 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The number or column expression to add.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1, 2, 3] })
-     * >>> df.with_columns($df.col("a").add(10).alias("added"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").add(10).alias("added"))
      * shape: (3, 2)
      * ┌───┬───────┐
      * │ a │ added │
@@ -75,48 +111,75 @@ export declare class ArithmeticExpr extends ExprBase {
      * Computes the arcsine of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 0.5, 1] })
-     * >>> df.with_columns($df.col("a").asin().alias("asin_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").asin().alias("asin_a"))
      * shape: (3, 2)
-     * ┌─────┬───────────┐
-     * │ a   │ asin_a    │
-     * ├─────┼───────────┤
-     * │ 0   │ 0         │
-     * │ 0.5 │ 0.523598  │
-     * │ 1   │ 1.570796  │
-     * └─────┴───────────┘
+     * ┌───┬──────────┐
+     * │ a │ asin_a   │
+     * ├───┼──────────┤
+     * │ 1 │ 1.570796 │
+     * │ 2 │ null     │
+     * │ 3 │ null     │
+     * └───┴──────────┘
      */
     asin(): this;
     /**
      * Computes the hyperbolic arcsine of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1, 2] })
-     * >>> df.with_columns($df.col("a").asinh().alias("asinh_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").asinh().alias("asinh_a"))
      * shape: (3, 2)
-     * ┌───┬───────────┐
-     * │ a │ asinh_a   │
-     * ├───┼───────────┤
-     * │ 0 │ 0         │
-     * │ 1 │ 0.881373  │
-     * │ 2 │ 1.443635  │
-     * └───┴───────────┘
+     * ┌───┬──────────┐
+     * │ a │ asinh_a  │
+     * ├───┼──────────┤
+     * │ 1 │ 0.881374 │
+     * │ 2 │ 1.443635 │
+     * │ 3 │ 1.818446 │
+     * └───┴──────────┘
      */
     asinh(): this;
     /**
      * Computes the arctangent of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1, 2] })
-     * >>> df.with_columns($df.col("a").atan().alias("atan_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").atan().alias("atan_a"))
      * shape: (3, 2)
-     * ┌───┬───────────┐
-     * │ a │ atan_a    │
-     * ├───┼───────────┤
-     * │ 0 │ 0         │
-     * │ 1 │ 0.785398  │
-     * │ 2 │ 1.107148  │
-     * └───┴───────────┘
+     * ┌───┬──────────┐
+     * │ a │ atan_a   │
+     * ├───┼──────────┤
+     * │ 1 │ 0.785398 │
+     * │ 2 │ 1.107149 │
+     * │ 3 │ 1.249046 │
+     * └───┴──────────┘
      */
     atan(): this;
     /**
@@ -124,62 +187,100 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The x denominator number or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1, 2], b: [2, 1] })
-     * >>> df.with_columns($df.col("a").atan2($df.col("b")).alias("atan2_a"))
-     * shape: (2, 3)
-     * ┌───┬───┬───────────┐
-     * │ a │ b │ atan2_a   │
-     * ├───┼───┼───────────┤
-     * │ 1 │ 2 │ 0.463647  │
-     * │ 2 │ 1 │ 1.107148  │
-     * └───┴───┴───────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3], b: [10, 20, 30] })
+ * >>> df
+ * shape: (3, 2)
+ * ┌───┬────┐
+ * │ a │ b  │
+ * ├───┼────┤
+ * │ 1 │ 10 │
+ * │ 2 │ 20 │
+ * │ 3 │ 30 │
+ * └───┴────┘
+     * >>> df.withColumns($df.col("a").atan2($df.col("b")).alias("atan2_a"))
+     * shape: (3, 3)
+     * ┌───┬────┬──────────┐
+     * │ a │ b  │ atan2_a  │
+     * ├───┼────┼──────────┤
+     * │ 1 │ 10 │ 0.099669 │
+     * │ 2 │ 20 │ 0.099669 │
+     * │ 3 │ 30 │ 0.099669 │
+     * └───┴────┴──────────┘
      */
     atan2(val: NumericArg): this;
     /**
      * Computes the hyperbolic arctangent of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 0.5] })
-     * >>> df.with_columns($df.col("a").atanh().alias("atanh_a"))
-     * shape: (2, 2)
-     * ┌─────┬───────────┐
-     * │ a   │ atanh_a   │
-     * ├─────┼───────────┤
-     * │ 0   │ 0         │
-     * │ 0.5 │ 0.549306  │
-     * └─────┴───────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").atanh().alias("atanh_a"))
+     * shape: (3, 2)
+     * ┌───┬─────────┐
+     * │ a │ atanh_a │
+     * ├───┼─────────┤
+     * │ 1 │ null    │
+     * │ 2 │ null    │
+     * │ 3 │ null    │
+     * └───┴─────────┘
      */
     atanh(): this;
     /**
      * Computes the cube root of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1, 8, 27] })
-     * >>> df.with_columns($df.col("a").cbrt().alias("cbrt_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").cbrt().alias("cbrt_a"))
      * shape: (3, 2)
-     * ┌────┬────────┐
-     * │ a  │ cbrt_a │
-     * ├────┼────────┤
-     * │ 1  │ 1      │
-     * │ 8  │ 2      │
-     * │ 27 │ 3      │
-     * └────┴────────┘
+     * ┌───┬──────────┐
+     * │ a │ cbrt_a   │
+     * ├───┼──────────┤
+     * │ 1 │ 1        │
+     * │ 2 │ 1.259921 │
+     * │ 3 │ 1.44225  │
+     * └───┴──────────┘
      */
     cbrt(): this;
     /**
      * Rounds column values up to the nearest integer.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1.1, 2.8, -0.5] })
-     * >>> df.with_columns($df.col("a").ceil().alias("ceil_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").ceil().alias("ceil_a"))
      * shape: (3, 2)
-     * ┌──────┬────────┐
-     * │ a    │ ceil_a │
-     * ├──────┼────────┤
-     * │ 1.1  │ 2      │
-     * │ 2.8  │ 3      │
-     * │ -0.5 │ 0      │
-     * └──────┴────────┘
+     * ┌───┬────────┐
+     * │ a │ ceil_a │
+     * ├───┼────────┤
+     * │ 1 │ 1      │
+     * │ 2 │ 2      │
+     * │ 3 │ 3      │
+     * └───┴────────┘
      */
     ceil(): this;
     /**
@@ -188,16 +289,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param upper The upper threshold value (default: null).
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [5, 15, 25] })
-     * >>> df.with_columns($df.col("a").clip(10, 20).alias("clipped"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").clip(2, 3).alias("clipped"))
      * shape: (3, 2)
-     * ┌────┬─────────┐
-     * │ a  │ clipped │
-     * ├────┼─────────┤
-     * │ 5  │ 10      │
-     * │ 15 │ 15      │
-     * │ 25 │ 20      │
-     * └────┴─────────┘
+     * ┌───┬─────────┐
+     * │ a │ clipped │
+     * ├───┼─────────┤
+     * │ 1 │ 2       │
+     * │ 2 │ 2       │
+     * │ 3 │ 3       │
+     * └───┴─────────┘
      */
     clip(lower?: number | null, upper?: number | null): this;
     /**
@@ -205,44 +315,74 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The sign source value or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [5, 10], b: [-1, 1] })
-     * >>> df.with_columns($df.col("a").copysign($df.col("b")).alias("signed"))
-     * shape: (2, 3)
-     * ┌────┬────┬────────┐
-     * │ a  │ b  │ signed │
-     * ├────┼────┼────────┤
-     * │ 5  │ -1 │ -5     │
-     * │ 10 │ 1  │ 10     │
-     * └────┴────┴────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3], b: [10, 20, 30] })
+ * >>> df
+ * shape: (3, 2)
+ * ┌───┬────┐
+ * │ a │ b  │
+ * ├───┼────┤
+ * │ 1 │ 10 │
+ * │ 2 │ 20 │
+ * │ 3 │ 30 │
+ * └───┴────┘
+     * >>> df.withColumns($df.col("a").copysign($df.col("b")).alias("signed"))
+     * shape: (3, 3)
+     * ┌───┬────┬────────┐
+     * │ a │ b  │ signed │
+     * ├───┼────┼────────┤
+     * │ 1 │ 10 │ 1      │
+     * │ 2 │ 20 │ 2      │
+     * │ 3 │ 30 │ 3      │
+     * └───┴────┴────────┘
      */
     copysign(val: NumericArg): this;
     /**
      * Computes the cosine of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, Math.PI] })
-     * >>> df.with_columns($df.col("a").cos().alias("cos_a"))
-     * shape: (2, 2)
-     * ┌───────┬───────┐
-     * │ a     │ cos_a │
-     * ├───────┼───────┤
-     * │ 0     │ 1     │
-     * │ 3.141 │ -1    │
-     * └───────┴───────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").cos().alias("cos_a"))
+     * shape: (3, 2)
+     * ┌───┬───────────┐
+     * │ a │ cos_a     │
+     * ├───┼───────────┤
+     * │ 1 │ 0.540302  │
+     * │ 2 │ -0.416147 │
+     * │ 3 │ -0.989992 │
+     * └───┴───────────┘
      */
     cos(): this;
     /**
      * Computes the hyperbolic cosine of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1] })
-     * >>> df.with_columns($df.col("a").cosh().alias("cosh_a"))
-     * shape: (2, 2)
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").cosh().alias("cosh_a"))
+     * shape: (3, 2)
      * ┌───┬───────────┐
      * │ a │ cosh_a    │
      * ├───┼───────────┤
-     * │ 0 │ 1         │
-     * │ 1 │ 1.543080  │
+     * │ 1 │ 1.543081  │
+     * │ 2 │ 3.762196  │
+     * │ 3 │ 10.067662 │
      * └───┴───────────┘
      */
     cosh(): this;
@@ -250,15 +390,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * Converts angles from radians to degrees.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, Math.PI] })
-     * >>> df.with_columns($df.col("a").degrees().alias("deg"))
-     * shape: (2, 2)
-     * ┌───────┬─────┐
-     * │ a     │ deg │
-     * ├───────┼─────┤
-     * │ 0     │ 0   │
-     * │ 3.141 │ 180 │
-     * └───────┴─────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").degrees().alias("deg"))
+     * shape: (3, 2)
+     * ┌───┬────────────┐
+     * │ a │ deg        │
+     * ├───┼────────────┤
+     * │ 1 │ 57.29578   │
+     * │ 2 │ 114.591559 │
+     * │ 3 │ 171.887339 │
+     * └───┴────────────┘
      */
     degrees(): this;
     /**
@@ -266,64 +416,100 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The denominator value or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [10, 20, 30] })
-     * >>> df.with_columns($df.col("a").div(2).alias("div_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").div(2).alias("div_a"))
      * shape: (3, 2)
-     * ┌────┬───────┐
-     * │ a  │ div_a │
-     * ├────┼───────┤
-     * │ 10 │ 5     │
-     * │ 20 │ 10    │
-     * │ 30 │ 15    │
-     * └────┴───────┘
+     * ┌───┬───────┐
+     * │ a │ div_a │
+     * ├───┼───────┤
+     * │ 1 │ 0.5   │
+     * │ 2 │ 1     │
+     * │ 3 │ 1.5   │
+     * └───┴───────┘
      */
     div(val: NumericArg): this;
     /**
      * Computes natural exponent (e^x) of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1, 2] })
-     * >>> df.with_columns($df.col("a").exp().alias("exp_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").exp().alias("exp_a"))
      * shape: (3, 2)
-     * ┌───┬──────────┐
-     * │ a │ exp_a    │
-     * ├───┼──────────┤
-     * │ 0 │ 1        │
-     * │ 1 │ 2.718281 │
-     * │ 2 │ 7.389056 │
-     * └───┴──────────┘
+     * ┌───┬───────────┐
+     * │ a │ exp_a     │
+     * ├───┼───────────┤
+     * │ 1 │ 2.718282  │
+     * │ 2 │ 7.389056  │
+     * │ 3 │ 20.085537 │
+     * └───┴───────────┘
      */
     exp(): this;
     /**
      * Computes e^x - 1 for each element in the column.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1, 2] })
-     * >>> df.with_columns($df.col("a").expm1().alias("expm1_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").expm1().alias("expm1_a"))
      * shape: (3, 2)
-     * ┌───┬──────────┐
-     * │ a │ expm1_a  │
-     * ├───┼──────────┤
-     * │ 0 │ 0        │
-     * │ 1 │ 1.718281 │
-     * │ 2 │ 6.389056 │
-     * └───┴──────────┘
+     * ┌───┬───────────┐
+     * │ a │ expm1_a   │
+     * ├───┼───────────┤
+     * │ 1 │ 1.718282  │
+     * │ 2 │ 6.389056  │
+     * │ 3 │ 19.085537 │
+     * └───┴───────────┘
      */
     expm1(): this;
     /**
      * Rounds column values down to the nearest integer.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1.1, 2.8, -0.5] })
-     * >>> df.with_columns($df.col("a").floor().alias("floor_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").floor().alias("floor_a"))
      * shape: (3, 2)
-     * ┌──────┬─────────┐
-     * │ a    │ floor_a │
-     * ├──────┼─────────┤
-     * │ 1.1  │ 1       │
-     * │ 2.8  │ 2       │
-     * │ -0.5 │ -1      │
-     * └──────┴─────────┘
+     * ┌───┬─────────┐
+     * │ a │ floor_a │
+     * ├───┼─────────┤
+     * │ 1 │ 1       │
+     * │ 2 │ 2       │
+     * │ 3 │ 3       │
+     * └───┴─────────┘
      */
     floor(): this;
     /**
@@ -331,16 +517,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The divisor value or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [5, 10, 15] })
-     * >>> df.with_columns($df.col("a").floordiv(2).alias("fdiv"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").floordiv(2).alias("fdiv"))
      * shape: (3, 2)
-     * ┌────┬──────┐
-     * │ a  │ fdiv │
-     * ├────┼──────┤
-     * │ 5  │ 2    │
-     * │ 10 │ 5    │
-     * │ 15 │ 7    │
-     * └────┴──────┘
+     * ┌───┬──────┐
+     * │ a │ fdiv │
+     * ├───┼──────┤
+     * │ 1 │ 0    │
+     * │ 2 │ 1    │
+     * │ 3 │ 1    │
+     * └───┴──────┘
      */
     floordiv(val: NumericArg): this;
     /**
@@ -348,15 +543,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The other numeric value or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [3, 5], b: [4, 12] })
-     * >>> df.with_columns($df.col("a").hypot($df.col("b")).alias("hypot_a"))
-     * shape: (2, 3)
-     * ┌───┬────┬─────────┐
-     * │ a │ b  │ hypot_a │
-     * ├───┼────┼─────────┤
-     * │ 3 │ 4  │ 5       │
-     * │ 5 │ 12 │ 13      │
-     * └───┴────┴─────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3], b: [10, 20, 30] })
+ * >>> df
+ * shape: (3, 2)
+ * ┌───┬────┐
+ * │ a │ b  │
+ * ├───┼────┤
+ * │ 1 │ 10 │
+ * │ 2 │ 20 │
+ * │ 3 │ 30 │
+ * └───┴────┘
+     * >>> df.withColumns($df.col("a").hypot($df.col("b")).alias("hypot_a"))
+     * shape: (3, 3)
+     * ┌───┬────┬───────────┐
+     * │ a │ b  │ hypot_a   │
+     * ├───┼────┼───────────┤
+     * │ 1 │ 10 │ 10.049876 │
+     * │ 2 │ 20 │ 20.099751 │
+     * │ 3 │ 30 │ 30.149627 │
+     * └───┴────┴───────────┘
      */
     hypot(val: NumericArg): this;
     /**
@@ -364,31 +569,49 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param base The base of the logarithm (default: Math.E).
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1, 10, 100] })
-     * >>> df.with_columns($df.col("a").log(10).alias("log_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").log(10).alias("log_a"))
      * shape: (3, 2)
-     * ┌─────┬───────┐
-     * │ a   │ log_a │
-     * ├─────┼───────┤
-     * │ 1   │ 0     │
-     * │ 10  │ 1     │
-     * │ 100 │ 2     │
-     * └─────┴───────┘
+     * ┌───┬──────────┐
+     * │ a │ log_a    │
+     * ├───┼──────────┤
+     * │ 1 │ 0        │
+     * │ 2 │ 0.30103  │
+     * │ 3 │ 0.477121 │
+     * └───┴──────────┘
      */
     log(base?: number): this;
     /**
      * Computes natural logarithm of 1 + x.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1, 2] })
-     * >>> df.with_columns($df.col("a").log1p().alias("log1p_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").log1p().alias("log1p_a"))
      * shape: (3, 2)
      * ┌───┬──────────┐
      * │ a │ log1p_a  │
      * ├───┼──────────┤
-     * │ 0 │ 0        │
      * │ 1 │ 0.693147 │
      * │ 2 │ 1.098612 │
+     * │ 3 │ 1.386294 │
      * └───┴──────────┘
      */
     log1p(): this;
@@ -397,16 +620,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The divisor value or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [10, 11, 12] })
-     * >>> df.with_columns($df.col("a").mod(2).alias("mod_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").mod(2).alias("mod_a"))
      * shape: (3, 2)
-     * ┌────┬───────┐
-     * │ a  │ mod_a │
-     * ├────┼───────┤
-     * │ 10 │ 0     │
-     * │ 11 │ 1     │
-     * │ 12 │ 0     │
-     * └────┴───────┘
+     * ┌───┬───────┐
+     * │ a │ mod_a │
+     * ├───┼───────┤
+     * │ 1 │ 1     │
+     * │ 2 │ 0     │
+     * │ 3 │ 1     │
+     * └───┴───────┘
      */
     mod(val: NumericArg): this;
     /**
@@ -414,8 +646,17 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The multiplier value or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1, 2, 3] })
-     * >>> df.with_columns($df.col("a").mul(5).alias("multiplied"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").mul(5).alias("multiplied"))
      * shape: (3, 2)
      * ┌───┬────────────┐
      * │ a │ multiplied │
@@ -430,16 +671,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * Negates column values (-x).
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1, -2, 3] })
-     * >>> df.with_columns($df.col("a").negate().alias("negated"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").negate().alias("negated"))
      * shape: (3, 2)
-     * ┌────┬─────────┐
-     * │ a  │ negated │
-     * ├────┼─────────┤
-     * │ 1  │ -1      │
-     * │ -2 │ 2       │
-     * │ 3  │ -3      │
-     * └────┴─────────┘
+     * ┌───┬─────────┐
+     * │ a │ negated │
+     * ├───┼─────────┤
+     * │ 1 │ -1      │
+     * │ 2 │ -2      │
+     * │ 3 │ -3      │
+     * └───┴─────────┘
      */
     negate(): this;
     /**
@@ -447,15 +697,24 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The exponent power value or column expression.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [2, 3, 4] })
-     * >>> df.with_columns($df.col("a").pow(2).alias("pow_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").pow(2).alias("pow_a"))
      * shape: (3, 2)
      * ┌───┬───────┐
      * │ a │ pow_a │
      * ├───┼───────┤
+     * │ 1 │ 1     │
      * │ 2 │ 4     │
      * │ 3 │ 9     │
-     * │ 4 │ 16    │
      * └───┴───────┘
      */
     pow(val: NumericArg): this;
@@ -463,15 +722,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * Converts angles from degrees to radians.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 180] })
-     * >>> df.with_columns($df.col("a").radians().alias("rad"))
-     * shape: (2, 2)
-     * ┌─────┬──────────┐
-     * │ a   │ rad      │
-     * ├─────┼──────────┤
-     * │ 0   │ 0        │
-     * │ 180 │ 3.141592 │
-     * └─────┴──────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").radians().alias("rad"))
+     * shape: (3, 2)
+     * ┌───┬──────────┐
+     * │ a │ rad      │
+     * ├───┼──────────┤
+     * │ 1 │ 0.017453 │
+     * │ 2 │ 0.034907 │
+     * │ 3 │ 0.05236  │
+     * └───┴──────────┘
      */
     radians(): this;
     /**
@@ -480,16 +749,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param options Config options including min, max, and integer flag.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ index: [1, 2, 3] })
-     * >>> df.with_columns($df.col("index").rand(42, { min: 1, max: 10, integer: true }).alias("random"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").rand(42, { min: 1, max: 10, integer: true }).alias("random"))
      * shape: (3, 2)
-     * ┌───────┬────────┐
-     * │ index │ random │
-     * ├───────┼────────┤
-     * │ 1     │ 2      │
-     * │ 2     │ 5      │
-     * │ 3     │ 6      │
-     * └───────┴────────┘
+     * ┌───┬────────┐
+     * │ a │ random │
+     * ├───┼────────┤
+     * │ 1 │ 7      │
+     * │ 2 │ 8      │
+     * │ 3 │ 6      │
+     * └───┴────────┘
      */
     rand(seed?: number, { min, max, integer }?: RandomOptions): this;
     /**
@@ -497,76 +775,125 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param decimals Number of decimal places to round to (default: 0).
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1.123, 2.789] })
-     * >>> df.with_columns($df.col("a").round(2).alias("rounded"))
-     * shape: (2, 2)
-     * ┌───────┬─────────┐
-     * │ a     │ rounded │
-     * ├───────┼─────────┤
-     * │ 1.123 │ 1.12    │
-     * │ 2.789 │ 2.79    │
-     * └───────┴─────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").round(1).alias("rounded"))
+     * shape: (3, 2)
+     * ┌───┬─────────┐
+     * │ a │ rounded │
+     * ├───┼─────────┤
+     * │ 1 │ 1       │
+     * │ 2 │ 2       │
+     * │ 3 │ 3       │
+     * └───┴─────────┘
      */
     round(decimals?: number): this;
     /**
      * Rounds values to a specific number of significant figures.
-     * @param sig_figs Number of significant figures.
+     * @param sigFigs Number of significant figures.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [123.45, 0.006789] })
-     * >>> df.with_columns($df.col("a").round_sig_figs(3).alias("sig_figs"))
-     * shape: (2, 2)
-     * ┌──────────┬──────────┐
-     * │ a        │ sig_figs │
-     * ├──────────┼──────────┤
-     * │ 123.45   │ 123      │
-     * │ 0.006789 │ 0.00679  │
-     * └──────────┴──────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").roundSigFigs(2).alias("sig_figs"))
+     * shape: (3, 2)
+     * ┌───┬──────────┐
+     * │ a │ sig_figs │
+     * ├───┼──────────┤
+     * │ 1 │ 1        │
+     * │ 2 │ 2        │
+     * │ 3 │ 3        │
+     * └───┴──────────┘
      */
-    round_sig_figs(sig_figs: number): this;
+    roundSigFigs(sigFigs: number): this;
     /**
      * Returns sign indicator of column values (-1, 0, or 1).
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [-10, 0, 50] })
-     * >>> df.with_columns($df.col("a").sign().alias("sign_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").sign().alias("sign_a"))
      * shape: (3, 2)
-     * ┌─────┬────────┐
-     * │ a   │ sign_a │
-     * ├─────┼────────┤
-     * │ -10 │ -1     │
-     * │ 0   │ 0      │
-     * │ 50  │ 1      │
-     * └─────┴────────┘
+     * ┌───┬────────┐
+     * │ a │ sign_a │
+     * ├───┼────────┤
+     * │ 1 │ 1      │
+     * │ 2 │ 1      │
+     * │ 3 │ 1      │
+     * └───┴────────┘
      */
     sign(): this;
     /**
      * Computes the sine of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, Math.PI / 2] })
-     * >>> df.with_columns($df.col("a").sin().alias("sin_a"))
-     * shape: (2, 2)
-     * ┌───────┬───────┐
-     * │ a     │ sin_a │
-     * ├───────┼───────┤
-     * │ 0     │ 0     │
-     * │ 1.570 │ 1     │
-     * └───────┴───────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").sin().alias("sin_a"))
+     * shape: (3, 2)
+     * ┌───┬──────────┐
+     * │ a │ sin_a    │
+     * ├───┼──────────┤
+     * │ 1 │ 0.841471 │
+     * │ 2 │ 0.909297 │
+     * │ 3 │ 0.14112  │
+     * └───┴──────────┘
      */
     sin(): this;
     /**
      * Computes the hyperbolic sine of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1] })
-     * >>> df.with_columns($df.col("a").sinh().alias("sinh_a"))
-     * shape: (2, 2)
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").sinh().alias("sinh_a"))
+     * shape: (3, 2)
      * ┌───┬───────────┐
      * │ a │ sinh_a    │
      * ├───┼───────────┤
-     * │ 0 │ 0         │
      * │ 1 │ 1.175201  │
+     * │ 2 │ 3.62686   │
+     * │ 3 │ 10.017875 │
      * └───┴───────────┘
      */
     sinh(): this;
@@ -574,16 +901,25 @@ export declare class ArithmeticExpr extends ExprBase {
      * Computes the square root of non-negative column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [4, 9, 16] })
-     * >>> df.with_columns($df.col("a").sqrt().alias("sqrt_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").sqrt().alias("sqrt_a"))
      * shape: (3, 2)
-     * ┌────┬────────┐
-     * │ a  │ sqrt_a │
-     * ├────┼────────┤
-     * │ 4  │ 2      │
-     * │ 9  │ 3      │
-     * │ 16 │ 4      │
-     * └────┴────────┘
+     * ┌───┬──────────┐
+     * │ a │ sqrt_a   │
+     * ├───┼──────────┤
+     * │ 1 │ 1        │
+     * │ 2 │ 1.414214 │
+     * │ 3 │ 1.732051 │
+     * └───┴──────────┘
      */
     sqrt(): this;
     /**
@@ -591,62 +927,100 @@ export declare class ArithmeticExpr extends ExprBase {
      * @param val The value or column expression to subtract.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [10, 20, 30] })
-     * >>> df.with_columns($df.col("a").sub(5).alias("sub_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").sub(5).alias("sub_a"))
      * shape: (3, 2)
-     * ┌────┬───────┐
-     * │ a  │ sub_a │
-     * ├────┼───────┤
-     * │ 10 │ 5     │
-     * │ 20 │ 15    │
-     * │ 30 │ 25    │
-     * └────┴───────┘
+     * ┌───┬───────┐
+     * │ a │ sub_a │
+     * ├───┼───────┤
+     * │ 1 │ -4    │
+     * │ 2 │ -3    │
+     * │ 3 │ -2    │
+     * └───┴───────┘
      */
     sub(val: NumericArg): this;
     /**
      * Computes the tangent of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, Math.PI / 4] })
-     * >>> df.with_columns($df.col("a").tan().alias("tan_a"))
-     * shape: (2, 2)
-     * ┌───────┬───────┐
-     * │ a     │ tan_a │
-     * ├───────┼───────┤
-     * │ 0     │ 0     │
-     * │ 0.785 │ 1     │
-     * └───────┴───────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").tan().alias("tan_a"))
+     * shape: (3, 2)
+     * ┌───┬───────────┐
+     * │ a │ tan_a     │
+     * ├───┼───────────┤
+     * │ 1 │ 1.557408  │
+     * │ 2 │ -2.18504  │
+     * │ 3 │ -0.142547 │
+     * └───┴───────────┘
      */
     tan(): this;
     /**
      * Computes the hyperbolic tangent of the column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [0, 1] })
-     * >>> df.with_columns($df.col("a").tanh().alias("tanh_a"))
-     * shape: (2, 2)
-     * ┌───┬───────────┐
-     * │ a │ tanh_a    │
-     * ├───┼───────────┤
-     * │ 0 │ 0         │
-     * │ 1 │ 0.761594  │
-     * └───┴───────────┘
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").tanh().alias("tanh_a"))
+     * shape: (3, 2)
+     * ┌───┬──────────┐
+     * │ a │ tanh_a   │
+     * ├───┼──────────┤
+     * │ 1 │ 0.761594 │
+     * │ 2 │ 0.964028 │
+     * │ 3 │ 0.995055 │
+     * └───┴──────────┘
      */
     tanh(): this;
     /**
      * Truncates fractional digits of column values.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ a: [1.1, 2.9, -3.5] })
-     * >>> df.with_columns($df.col("a").trunc().alias("trunc_a"))
+ * >>> const df = $df.data({ a: [1, 2, 3] })
+ * >>> df
+ * shape: (3, 1)
+ * ┌───┐
+ * │ a │
+ * ├───┤
+ * │ 1 │
+ * │ 2 │
+ * │ 3 │
+ * └───┘
+     * >>> df.withColumns($df.col("a").trunc().alias("trunc_a"))
      * shape: (3, 2)
-     * ┌──────┬─────────┐
-     * │ a    │ trunc_a │
-     * ├──────┼─────────┤
-     * │ 1.1  │ 1       │
-     * │ 2.9  │ 2       │
-     * │ -3.5 │ -3      │
-     * └──────┴─────────┘
+     * ┌───┬─────────┐
+     * │ a │ trunc_a │
+     * ├───┼─────────┤
+     * │ 1 │ 1       │
+     * │ 2 │ 2       │
+     * │ 3 │ 3       │
+     * └───┴─────────┘
      */
     trunc(): this;
 }