This function is used in Python Scripting.

Description

Given a sequence of values, calculates the sum of the natural logs (ln).

Returns NaN (Not a Number) if passed an empty sequence.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.math.sumLog(values)

  • Parameters

List[Float] values - A sequence of numerical values. Accepts both integers and floats. The sequence may not contain None type values. However, passing a None type object instead of a sequence of numerical values will return NaN.

  • Returns

Float - The sum of the natural logs of the input values, or NaN if the input was empty, None, or contains negative numbers.

  • Scope

Gateway, Vision Client, Perspective Session

Code Example
Code Snippet
# Create a list of values.
values = [3.5, 5.6, 7.8, 7.4, 3.8]
  
# Print the resulting value.
print system.math.sumLog(values)
Keywords

system math sumLog, math.sumLog