Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

Given a sequence of values, returns the greatest value in the sequence, also known as the "max" value.

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

Client permissions restrictions


Panel
titleSyntax

system.math.max(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 maximum value contained in the values parameter, or NaN if the input was empty or null.

  • Scope

Gateway, Vision Client, Perspective Session

Panel
titleCode Example
Code Block
languagepy
titleCode Snippet - Getting the Max Value from List
# Create a list of values.
values = [3.5, 5.6, 7.8, 7.4, 3.8]
 
# Prints the resulting value.
print system.math.max(values)
Code Block
languagepy
titleCode Snippet - Getting the Max Value from Tag Values
# Create a List of Tag Paths to read
paths = ["[Sample_Tags]/ReadOnly/ReadOnlyInteger1","[Sample_Tags]/ReadOnly/ReadOnlyInteger2","[Sample_Tags]/ReadOnly/ReadOnlyInteger3","[Sample_Tags]/ReadOnly/ReadOnlyInteger4","[Sample_Tags]/ReadOnly/ReadOnlyInteger5"]
 
# Read the Tags, and store the complex results in a variable
values = system.tag.readBlocking(paths)

# Declare an empty list to append to later
tagValuesList = []

# For each Tag Path, iterate through our results...
for index in range(len(paths)):
     
    # ...grab the Tag values...
    tagValue = values[index].value
    # ...and append them to the empty list from earlier
    tagValuesList.append(tagValue)

# Print out the maximum value in the list
print system.math.max(tagValuesList)
Panel
titleKeywords

system math max, math.max