This function is used in Python Scripting.

Description

Given a sequence of values, calculates the variance of all values. Variance measures how far values in a set are spread out from their mean value.

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

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.math.variance(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 variance of all values in the values parameter, or NaN if the input was empty or null.

  • 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.variance(values)
Keywords

system math variance, math.variance