feat: add functions for arithmetic, rounding, logarithmic, and string…

… transformations (#245) * feat: add functions for arithmetic, rounding, logarithmic, and string transformations Co-authored-by: Sanjiban Sengupta <[email protected]>
substrait-io · Jul 25, 2022 · f7c5da5 · f7c5da5
1 parent 42d9ca3
commit f7c5da5
Show file tree

Hide file tree

Showing 5 changed files with 220 additions and 1 deletion.
diff --git a/extensions/functions_arithmetic.yaml b/extensions/functions_arithmetic.yaml
@@ -161,6 +161,36 @@ scalar_functions:
           - value: fp64
           - value: fp64
         return: fp64
+  -
+    name: "negate"
+    description: "Negation of the value"
+    impls:
+      - args:
+          - options: [ SILENT, SATURATE, ERROR ]
+            required: false
+          - value: i8
+        return: i8
+      - args:
+          - options: [ SILENT, SATURATE, ERROR ]
+            required: false
+          - value: i16
+        return: i16
+      - args:
+          - options: [ SILENT, SATURATE, ERROR ]
+            required: false
+          - value: i32
+        return: i32
+      - args:
+          - options: [ SILENT, SATURATE, ERROR ]
+            required: false
+          - value: i64
+        return: i64
+      - args:
+          - value: fp32
+        return: fp32
+      - args:
+          - value: fp64
+        return: fp64
   -
     name: "modulus"
     description: "Get the remainder when dividing one value by another."
@@ -181,6 +211,55 @@ scalar_functions:
           - value: i64
           - value: i64
         return: i64
+  -
+    name: "power"
+    description: "Take the power with the first value as the base and second as exponent."
+    impls:
+      - args:
+          - options: [ SILENT, SATURATE, ERROR ]
+            required: false
+          - value: i64
+          - value: i64
+        return: i64
+      - args:
+          - value: fp32
+          - value: fp32
+        return: fp32
+      - args:
+          - value: fp64
+          - value: fp64
+        return: fp64
+  -
+    name: "sqrt"
+    description: "Square root of the value"
+    impls:
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: i64
+        return: fp64
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp32
+        return: fp32
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp64
+        return: fp64
 aggregate_functions:
   - name: "sum"
     description: Sum a set of values. The sum of zero elements yields null.

diff --git a/extensions/functions_comparison.yaml b/extensions/functions_comparison.yaml
@@ -73,4 +73,14 @@ scalar_functions:
           - value: any1
         return: BOOLEAN
         nullability: DECLARED_OUTPUT
+  -
+    name: "is_nan"
+    description: Whether a value is not a number.
+    impls:
+      - args:
+          - value: fp32
+        return: BOOLEAN
+      - args:
+          - value: fp64
+        return: BOOLEAN
 
diff --git a/extensions/functions_logarithmic.yaml b/extensions/functions_logarithmic.yaml
@@ -0,0 +1,106 @@
+%YAML 1.2
+---
+scalar_functions:
+  -
+    name: "ln"
+    description: "Natural logarithm of the value"
+    impls:
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp32
+        return: fp32
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp64
+        return: fp64
+  -
+    name: "log10"
+    description: "Logarithm to base 10 of the value"
+    impls:
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp32
+        return: fp32
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp64
+        return: fp64
+  -
+    name: "log2"
+    description: "Logarithm to base 2 of the value"
+    impls:
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp32
+        return: fp32
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp64
+        return: fp64
+  -
+    name: "logb"
+    description: >
+      Logarithm of the value with the given base
+
+      logb(x, b) => log_{b} (x)
+    impls:
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp32
+            name: "x"
+            description: "The number `x` to compute the logarithm of"
+          - value: fp32
+            name: "base"
+            description: "The logarithm base `b` to use"
+        return: fp32
+      - args:
+          - name: rounding
+            options: [ TIE_TO_EVEN, TIE_AWAY_FROM_ZERO, TRUNCATE, CEILING, FLOOR ]
+            required: false
+          - name: on_domain_error
+            options: [ NAN, ERROR ]
+            required: false
+          - value: fp64
+            name: "x"
+            description: "The number `x` to compute the logarithm of"
+          - value: fp64
+            name: "base"
+            description: "The logarithm base `b` to use"
+        return: fp64
+
+
diff --git a/extensions/functions_rounding.yaml b/extensions/functions_rounding.yaml
@@ -0,0 +1,23 @@
+%YAML 1.2
+---
+scalar_functions:
+  -
+    name: "ceil"
+    description: "Rounding to the ceiling of the value"
+    impls:
+      - args:
+          - value: fp32
+        return: fp32
+      - args:
+          - value: fp64
+        return: fp64
+  -
+    name: "floor"
+    description: "Rounding to the floor of the value"
+    impls:
+      - args:
+          - value: fp32
+        return: fp32
+      - args:
+          - value: fp64
+        return: fp64
diff --git a/extensions/functions_string.yaml b/extensions/functions_string.yaml
@@ -44,7 +44,8 @@ scalar_functions:
           - value: i32
           - value: i32
         return: "string"
-  - name: starts_with
+  - 
+    name: starts_with
     description: Whether this string starts with another string.
     impls:
       - args: