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

Natural logarithm of the value

Implementations:

  • ln(x: i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
  • ln(x: fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32
  • ln(x: fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
  • ln(x: decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
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

    Logarithm to base 10 of the value

    Implementations:

    • log10(x: i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    • log10(x: fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32
    • log10(x: fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    • log10(x: decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    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

    Logarithm to base 2 of the value

    Implementations:

    • log2(x: i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    • log2(x: fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32
    • log2(x: fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    • log2(x: decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    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

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

    Implementations:

    • logb(x: i64, base: i64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    • logb(x: fp32, base: fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32
    • logb(x: fp64, base: fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    • logb(x: decimal<P1,S1>, base: decimal<P1,S1>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    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

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

    Implementations:

    • log1p(x: fp32, option:rounding, option:on_domain_error, option:on_log_zero): -> fp32
    • log1p(x: fp64, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    • log1p(x: decimal<P,S>, option:rounding, option:on_domain_error, option:on_log_zero): -> fp64
    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']