Skip to content

functions_logarithmic.yaml

This document file is generated for functions_logarithmic.yaml. The extension URN is extension:io.substrait:functions_logarithmic.

Scalar Functions

ln

Implementations: ln(x, option:rounding, option:on_domain_error, option:on_log_zero): -> return_type 0. ln(i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64 1. ln(fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32 2. ln(fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64 3. ln(decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64

Natural logarithm of the value

Options:
  • on_domain_error ['NAN', 'NULL', 'ERROR']
  • on_log_zero ['NAN', 'ERROR', 'MINUS_INFINITY']
  • rounding ['TIE_TO_EVEN', 'TIE_AWAY_FROM_ZERO', 'TRUNCATE', 'CEILING', 'FLOOR']

    • log10

    Implementations: log10(x, option:rounding, option:on_domain_error, option:on_log_zero): -> return_type 0. log10(i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64 1. log10(fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32 2. log10(fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64 3. log10(decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64

    Logarithm to base 10 of the value

    Options:
  • on_domain_error ['NAN', 'NULL', 'ERROR']
  • on_log_zero ['NAN', 'ERROR', 'MINUS_INFINITY']
  • rounding ['TIE_TO_EVEN', 'TIE_AWAY_FROM_ZERO', 'TRUNCATE', 'CEILING', 'FLOOR']

    • log2

    Implementations: log2(x, option:rounding, option:on_domain_error, option:on_log_zero): -> return_type 0. log2(i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64 1. log2(fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32 2. log2(fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64 3. log2(decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64

    Logarithm to base 2 of the value

    Options:
  • on_domain_error ['NAN', 'NULL', 'ERROR']
  • on_log_zero ['NAN', 'ERROR', 'MINUS_INFINITY']
  • rounding ['TIE_TO_EVEN', 'TIE_AWAY_FROM_ZERO', 'TRUNCATE', 'CEILING', 'FLOOR']

    • logb

    Implementations: logb(x, base, option:rounding, option:on_domain_error, option:on_log_zero): -> return_type

  • x: The number `x` to compute the logarithm of
  • base: The logarithm base `b` to use
    1. logb(i64, i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    2. logb(fp32, fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32
    3. logb(fp64, fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    4. logb(decimal<P1,S1>, decimal<P1,S1>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64

    *Logarithm of the value with the given base logb(x, b) => log_{b} (x) *

    Options:
  • on_domain_error ['NAN', 'NULL', 'ERROR']
  • on_log_zero ['NAN', 'ERROR', 'MINUS_INFINITY']
  • rounding ['TIE_TO_EVEN', 'TIE_AWAY_FROM_ZERO', 'TRUNCATE', 'CEILING', 'FLOOR']

    • log1p

    Implementations: log1p(x, option:rounding, option:on_domain_error, option:on_log_zero): -> return_type 0. log1p(fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32 1. log1p(fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64 2. log1p(decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64

    *Natural logarithm (base e) of 1 + x log1p(x) => log(1+x) *

    Options:
  • on_domain_error ['NAN', 'NULL', 'ERROR']
  • on_log_zero ['NAN', 'ERROR', 'MINUS_INFINITY']
  • rounding ['TIE_TO_EVEN', 'TIE_AWAY_FROM_ZERO', 'TRUNCATE', 'CEILING', 'FLOOR']