cmp

Written as cmp(argnum flags):options in a transform expression.

Minimum arguments	2
Maximum arguments	2
Default arguments	2
Argument modes	MULTIPLE

Documentation

Compare 2 arguments and return whether the left hand side is less/greater than or equal to the right hand side.

By default, the comparison result is returned as -1, 0, or 1, indicating the left hand side is:

• less than, or
• equal to, or
• greater than the right hand side.

However, any of below explicit comparators can be specified in the options string:

• < (less than)
• <= (less than or equal to)
• = (equal to)
• > (greater than)
• >= (greater than or equal to)

and in this case, a boolean true/false will be returned instead of -1, 0, or 1.

Note:

• the LHS and RHS must be comparable, otherwise error will be raised

Flags

Flag	Letter
spread_input	s
noncaptive_input	I

Examples

Numbers (same type) - less than

Input args: [10,20]
Transforms: "cmp:"
Output: -1

Numbers (same type) - greater than

Input args: [3.14,2.71]
Transforms: "cmp:"
Output: 1

With explicit comparator (less than)

Input args: [10,20]
Transforms: "cmp:<"
Output: true

With explicit comparator (less than or equal)

Input args: [3.14,2.71]
Transforms: "cmp:<="
Output: false

Numbers (mixed type)

Input args: [5,3.14]
Transforms: "cmp:"
Output: 1

Strings

Input args: ["apple","banana"]
Transforms: "cmp:"
Output: -1

Datetimes

Input args: ["2023-01-01T00:00:00","2023-01-02T00:00:00"]
Transforms: "cmp:"
Output: -1

Equal values

Input args: [100,100]
Transforms: "cmp:"
Output: 0

In comparable values raise error

Input args: [100,"xyz"]
Transforms: "cmp:"
Output: N/A
Error: "Cannot compare int and str"