Mathematical function calls

4 minutes to read

max

Returns the largest value from the specified arguments.

Input parameters

• Two or more values that are all either of type Date and time or of a numeric type (Integer/Long, Float or Decimal).

Output

Returns the largest value from the specified arguments. If the arguments are of type Date and time, the result will also be of type Date and time. If the arguments are numeric, the result will be of the most precise type. For example, if both an Integer/Long and a Decimal argument are specified, the result will be of type Decimal.

Type: Integer/Long or Decimal

``````max(5, 1, 5, 6.7)

``````

returns:

``````6.7

``````

of type “Decimal”.

min

Returns the smallest value from the specified arguments.

Input

Two or more values that are all either of type Date and time or of a numeric type (Integer/Long, Float or Decimal).

Output

Returns the smallest value from the specified arguments. If the arguments are of type Date and time, the result will also be of type Date and time. If the arguments are numeric, the result will be of the most precise type. For example, if both an Integer/Long and a Decimal argument are specified, the result will be of type Decimal.

Type: Integer/Long or Decimal

``````min(5, 1, 5, 6.7)

``````

returns:

``````1

``````

of type “Decimal”.

round

Rounds a number to a certain precision.

Input

• a number Type: Integer/Long, Float or Decimal

• a precision (optional)  Type: Integer/Long

Output

In the Settings, your option for Round numbers can be set: * For the Half away from zero option (also called “commercial rounding”), +2.5 becomes +3 and -1.5 becomes -2 * The Half to the nearest even number option (also called “bankers’ rounding”) is the default rounding mode used in IEEE 754 computing functions and operators; for example, +23.5 becomes +24, as does +24.5; and -22.5 becomes -22, as does -21.5

The second optional parameter determines the precision of the rounding. The default value is 0. The result will be of the most precise type possible. For a precision of 0, the result will be of integer/long type, and for all other precision values, the result will be of the decimal type.

Type: Integer/Long or Decimal

``````round(3.5)

``````

returns:

``````4

``````

of type “Integer/Long”

and

``````round(88.725,2)

``````

returns:

``````88.72
``````

of type “Decimal”

random

Generates a random number >= 0.0 and < 1.0

Output

A random number between 0.0 and 1.0 Type: Decimal

``````random()

``````

floor

Rounds down to an integer (everything after the decimal point is ignored).

Input

• a number Type: Integer/Long, Float or Decimal

Output

The input value rounded down to the nearest integer.

Type: Integer/Long

``````floor(3.9)

``````

returns:

``````3

``````

and

``````floor(-1.2)

``````

returns:

``````-2

``````

ceil

Rounds up to an integer (everything after the decimal point is rounded up).

Input

• a number Type: Integer/Long, Float or Decimal

Output

The input value rounded down to the nearest integer.

Type: Integer/Long

``````ceil(3.2)

``````

returns:

``````4

``````

and

``````ceil(-1.9)

``````

returns:

``````-1

``````

pow

Calculates the exponent of a number to a certain power.

Input

• a number  Type: Integer/Long, Float or Decimal
• a power  Type: Integer/Long, Float or Decimal

Output

The number to the power, i.e. n^p. The result will be of the most precise type necessary.

Type: Integer/Long or Decimal

``````pow(2, 3)

``````

returns:

``````8

``````

of type “Integer/Long”

and

``````pow(2.5, 3)

``````

returns:

``````15.625
``````

of type “Decimal”

abs

Calculates the absolute value of a number (ie not negative).

Input

• a number Type: Integer/Long, Float or Decimal

Output

The absolute value of the input, which is never negative. Corresponds to taking the square and then the square root.

Type: Integer/Long or Decimal

``````abs(-5)

``````

and

``````abs(5)

``````

both return:

``````5

``````

floatsEqual

Input

• a number  Type: Integer/Long or Float
• another number  Type: Integer/Long or Float
• a precision Type: Integer/Long

Output

Compares the two numbers to decimal point p, which is equal to Precision.

Type: Boolean

``````floatsEqual(0.51, 0.50, 1)

``````

returns:

``````true

``````

and

``````floatsEqual(0.51, 0.50, 2)

``````

returns:

``````false

``````

currenciesEqual

See floatsEqual.

The currenciesEqual function is a synonym for floatsEqual. However, we recommend the use of the high-precision Decimal type to represent money. Equality of Decimal numbers can be determined with the = operator.