Numeric functions
This page describes the available functions to assist with performing numeric calculations.
abs#
abs(value) return the absolute value. The behavior of abs is as follows:
- When the input
valueis positive,absreturnsvalue - When the input
valueis negative,absreturns- value - When the input
valueis0,absreturns0
Arguments:
valueis any numeric value.
Return value:
Return value type is the same as the type of the argument.
Examples:
| a | abs |
|---|---|
| -1 | 1 |
| 0 | 0 |
| 1 | 1 |
log#
log(value) return the natural logarithm (loge) of a given number.
Arguments:
valueis any numeric value.
Return value:
Return value type is double.
Examples:
| log |
|---|
| 1.4165810537 |
round#
round(value, scale) returns the closest value in the specified scale. It
uses the "half up" tie-breaking method when the value is exactly halfway between
the round_up and round_down values.
Arguments:
valueis any numeric value.scaleis the number of decimal points returned. A negative scale means the rounding will occur to a digit to the left of the decimal point. For example, -1 means the number will be rounded to the nearest tens and +1 to the nearest tenths.
Return value:
Return value type is double.
Examples:
| d | round-2 | round-1 | round0 | round1 | round2 |
|---|---|---|---|---|---|
| -0.811905406 | 0 | 0 | -1 | -0.8 | -0.81 |
| -5.002768547 | 0 | -10 | -5 | -5 | -5 |
| -64.75487334 | -100 | -60 | -65 | -64.8 | -64.75 |
| -926.531695 | -900 | -930 | -927 | -926.5 | -926.53 |
| 0.069361448 | 0 | 0 | 0 | 0.1 | 0.07 |
| 4.003627053 | 0 | 0 | 4 | 4 | 4 |
| 86.91359825 | 100 | 90 | 87 | 86.9 | 86.91 |
| 376.3807766 | 400 | 380 | 376 | 376.4 | 376.38 |
round_down#
round_down(value, scale) - rounds a value down to the specified scale
Arguments:
valueis any numeric value.scaleis the number of decimal points returned. A negative scale means the rounding will occur to a digit to the left of the decimal point. For example, -1 means the number will be rounded to the nearest tens and +1 to the nearest tenths.
Return value:
Return value type is double.
Examples:
| d | r_down-2 | r_down-1 | r_down0 | r_down1 | r_down2 |
|---|---|---|---|---|---|
| -0.811905406 | 0 | 0 | 0 | -0.8 | -0.81 |
| -5.002768547 | 0 | 0 | -5 | -5 | -5 |
| -64.75487334 | 0 | -60 | -64 | -64.7 | -64.75 |
| -926.531695 | -900 | -920 | -926 | -926.5 | -926.53 |
| 0.069361448 | 0 | 0 | 0 | 0 | 0.06 |
| 4.003627053 | 0 | 0 | 4 | 4 | 4 |
| 86.91359825 | 0 | 80 | 86 | 86.9 | 86.91 |
| 376.3807766 | 400 | 370 | 376 | 376.3 | 376.38 |
round_half_even#
round_half_even(value, scale) - returns the closest value in the specified
scale. It uses the "half up" tie-breaking method when the value is exactly
halfway between the round_up and round_down values.
Arguments:
valueis any numeric value.scaleis the number of decimal points returned. A negative scale means the rounding will occur to a digit to the left of the decimal point. For example, -1 means the number will be rounded to the nearest tens and +1 to the nearest tenths.
Return value:
Return value type is double.
Examples:
| round_half_even | round_half_even |
|---|---|
| 5.6 | 5.6 |
| d | r_h_e-2 | r_h_e-1 | r_h_e0 | r_h_e1 | r_h_e2 |
|---|---|---|---|---|---|
| -0.811905406 | 0 | 0 | -1 | -0.8 | -0.81 |
| -5.002768547 | 0 | 0 | -5 | -5 | -5 |
| -64.75487334 | -100 | -60 | -65 | -64.8 | -64.75 |
| -926.531695 | -900 | -930 | -927 | -926.5 | -926.53 |
| 0.069361448 | 0 | 0 | 0 | 0.1 | 0.07 |
| 4.003627053 | 0 | 0 | 4 | 4 | 4 |
| 86.91359825 | 100 | 90 | 87 | 86.9 | 86.91 |
| 376.3807766 | 400 | 380 | 376 | 376.4 | 376.38 |
round_up#
round_up(value, scale) - rounds a value up to the specified scale
Arguments:
valueis any numeric value.scaleis the number of decimal points returned. A negative scale means the rounding will occur to a digit to the left of the decimal point. For example, -1 means the number will be rounded to the nearest tens and +1 to the nearest tenths.
Return value:
Return value type is double.
Examples:
| d | r_up-2 | r_up-1 | r_up0 | r_up1 | r_up2 |
|---|---|---|---|---|---|
| -0.811905406 | -100 | -10 | -1 | -0.9 | -0.82 |
| -5.002768547 | -100 | -10 | -6 | -5.1 | -5.01 |
| -64.75487334 | -100 | -70 | -65 | -64.8 | -64.76 |
| -926.531695 | -1000 | -930 | -927 | -926.6 | -926.54 |
| 0.069361448 | 100 | 10 | 1 | 0.1 | 0.07 |
| 4.003627053 | 100 | 10 | 5 | 4.1 | 4.01 |
| 86.91359825 | 100 | 90 | 87 | 87 | 86.92 |
| 376.3807766 | 400 | 380 | 377 | 376.4 | 376.39 |
sqrt#
sqrt(value) return the square root of a given number.
Arguments:
valueis any numeric value.
Return value:
Return value type is double.
Examples:
| log |
|---|
| 63.2480829749013 |