Numeric functions
Reference documentation for Expressif functions in the numeric scope.
| Name | Overview |
|---|---|
absolute | Returns the absolute value of the argument value. |
add | Returns the sum of the input value and the parameter value. |
ceiling | Returns the smallest integer greater than or equal to the argument number. |
clip | Returns the value of an argument number, unless it is smaller than min, in which case it returns min, or greater than max, in which case it returns max. |
cube-power | Returns the the numeric argument value raised to the cube power. |
cube-root | Returns cube root of the numeric argument value. |
decrement | Returns the argument number decremented of one unit. |
divide | Returns the argument number divided by the parameter value. If the parameter value is 0, it returns null. |
floor | Returns the largest integer less than or equal to the argument number. |
greatest-common-divisor | Returns the greatest common divisor (GCD) of the argument integer and the parameter integer. Returns null if the argument is not an integer. |
human-readable-format-binary-bytes | Formats a numeric value as binary bytes using IEC prefixes. |
human-readable-format-decimal | Formats a numeric value using decimal SI prefixes. |
human-readable-format-decimal-bytes | Formats a numeric value as decimal bytes using SI prefixes. |
increment | Returns the argument number incremented of one unit. |
integer | Returns the value of an argument number rounded to the nearest integer. |
invert | Returns the reciprocal of the argument number, meaning the result of the division of 1 by the argument number. If the argument value is 0, it returns null. |
lowest-common-multiple | Returns the lowest common multiple (LCM) of the argument integer and the parameter integer. Returns null if the argument is not an integer. |
multiply | Returns the argument number multiplied by the parameter value. |
nth-root | Returns the root specified by the parameter value of the numeric argument value. |
null-to-zero | Returns the unmodified argument value except if the argument value is null, empty or whitespace then it returns 0. |
oppose | Returns the integer being the additive inverse of the argument meaning that their sum is equal to zero. The opposite of 0 is 0. |
percent-change | Returns the percentage change from the previous numeric value to the current input value. Returns null when the input or parameter cannot be evaluated or when the previous value is zero. |
power | Returns the the numeric argument value raised to the power specified by the parameter value. |
round | Returns the value of an argument number to the specified number of fractional digits. |
sign | Returns an integer that indicates the sign of the argument value. It returns -1 if the value is strictly negative, 0 if the value is 0 and 1 if the value is strictly positive. |
square-power | Returns the the numeric argument value raised to the square power. |
square-root | Returns square root of the numeric argument value. |
subtract | Returns the difference between the argument number and the parameter value. |