feat: add options for behaviour when dividing by zero or calculating …

…log zero (#329) BREAKING CHANGE: options were added to division and logarithmic functions.
substrait-io · Sep 15, 2022 · 1c170c8 · 1c170c8
1 parent 4764192
commit 1c170c8
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 1 deletion.
diff --git a/extensions/functions_arithmetic.yaml b/extensions/functions_arithmetic.yaml
@@ -175,7 +175,11 @@ scalar_functions:
         return: fp64
   -
     name: "divide"
-    description: "Divide one value by another. Partial values are truncated."
+    description: >
+      Divide x by y. In the case of integer division, partial values are truncated (i.e. rounded towards 0).
+      The `on_division_by_zero` option governs behavior in cases where y is 0 and x is not 0.
+      `LIMIT` means positive or negative infinity (depending on the sign of x and y).
+      If x and y are both 0 or both +/-infinity, behavior will be governed by `on_domain_error`.
     impls:
       - args:
           - name: overflow
@@ -220,6 +224,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_division_by_zero
+            options: [ LIMIT, NAN, ERROR ]
+            required: false
           - name: x
             value: fp32
           - name: y
@@ -232,6 +239,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_division_by_zero
+            options: [ LIMIT, NAN, ERROR ]
+            required: false
           - name: x
             value: fp64
           - name: y

diff --git a/extensions/functions_logarithmic.yaml b/extensions/functions_logarithmic.yaml
@@ -12,6 +12,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp32
         return: fp32
@@ -22,6 +25,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp64
         return: fp64
@@ -36,6 +42,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp32
         return: fp32
@@ -46,6 +55,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp64
         return: fp64
@@ -60,6 +72,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp32
         return: fp32
@@ -70,6 +85,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp64
         return: fp64
@@ -87,6 +105,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - value: fp32
             name: "x"
             description: "The number `x` to compute the logarithm of"
@@ -101,6 +122,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - value: fp64
             name: "x"
             description: "The number `x` to compute the logarithm of"
@@ -122,6 +146,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp32
         return: fp32
@@ -132,6 +159,9 @@ scalar_functions:
           - name: on_domain_error
             options: [ NAN, ERROR ]
             required: false
+          - name: on_log_zero
+            options: [NAN, ERROR, MINUS_INFINITY]
+            required: false
           - name: x
             value: fp64
         return: fp64