Number Processing Functions

Function

Description

Result Type

Backend Support

Frontend Support

abs(Double value)

Returns the absolute value of a value. If the argument is not negative, the argument is returned. If the argument is negative, the negation of the argument is returned.

If argument type is Integer or Long, return value is Long.

Double

Yes

Yes

acos(Double value)

Returns the arc cosine of an angle, in the range of 0.0 through pi.

Double

Yes

Yes

asin(Double value)

Returns the arc sine of an angle, in the range of -pi/2 through pi/2.

Double

Yes

Yes

atan(Double value)

Returns the arc tangent of an angle, in the range of -pi/2 through pi/2.

Double

Yes

Yes

avg(DataTable table, String field)

Returns the arithmetic mean of the numbers from a field in table. Target field name is specified by field.

Double

Yes

Yes

cbrt(Double value)

Returns the cube root of a value.

Double

Yes

Yes

ceil(Double value)

Returns the smallest (closest to negative infinity) value that is greater than or equal to the argument and is equal to a mathematical integer.

Double

Yes

Yes

cos(Double value)

Returns the trigonometric cosine of an angle. Angle is measured in radians.

Double

Yes

Yes

cosh(Double value)

Returns the hyperbolic cosine of a value.

Double

Yes

Yes

e()

Returns the base of the natural logarithms.

Double

Yes

Yes

eq(Long first, Long second)

Returns true if first argument is equal to the second argument (same as == operator).

Boolean

Yes

Yes

exp(Double value)

Returns Euler's number e raised to the power of value.

Double

Yes

Yes

floor(Double value)

Returns the largest (closest to positive infinity) value that is less than or equal to the argument and is equal to a mathematical integer.

Double

Yes

Yes

formatNumber(Number number, String pattern)

Formats argument number according to the formatting defined by string. Number formatting patterns are described here.

String

Yes

Yes

frequency(DataTable table [, String field])

Returns a table indicating the frequency of the numbers from a field in table. Target field name is specified by the field parameter, if no field is provided then the first field is used. Any floating point values are converted to integers for comparison.

Returns data table with fields:

• Value - Value from the input data table.

• Frequency - Number of times the value occurred in the input data table.

Data Table

Yes

Yes

ge(Long first, Long second)

Returns true if first argument is greater or equal than second argument (same as >= operator).

Boolean

Yes

Yes

gt(Long first, Long second)

Returns true if first argument is greater than second argument (same as > operator).

Boolean

Yes

Yes

le(Long first, Long second)

Returns true if first argument is less or equal than second argument (same as <= operator).

Boolean

Yes

Yes

linearRegression(Data Table table, String xSeriesFieldName, String ySeriesFieldName)

Returns data table containing a linear regression model calculated on values from table. The arguments xSeriesFieldName and ySeriesFieldName are the names of the fields in the data table to use for the X values and Y values in the regression calculation.

Returns data table with fields:

• Intercept - Intercept of the regression model.

• Slope - Slope of the regression model.

• Mean Square Error - The average squared differences between the actual values and the values predicted by the regression.

• Sum of Squared Errors - The sum of the squared differences between the actual values and the values predicted by the regression.

Data Table

Yes

Yes

log(Double value)

Returns the natural logarithm (base e) of a value.

Double

Yes

Yes

log10(Double value)

Returns the base 10 logarithm of a value.

Double

Yes

Yes

lt(Long first, Long second)

Returns true if first argument is less than second argument (same as < operator).

Boolean

Yes

Yes

max(DataTable table [, String field])

max(Double first, Double second)

If the initial argument is a data table table, returns the largest number from among the numbers in the field named field (or the table's first field if the field argument is missing).

If the initial argument is a numerical value, returns the maximum of first and second.

Double

Yes

Yes

median(DataTable table [, String field])

Returns the median of the values in a field in table. Target field name is specified by field parameter, if no field is provided then the first field is used.

Double

Yes

Yes

min(DataTable table [, String field])

min(Double first, Double second)

If the initial argument is a data table table, returns the smallest number from among the numbers in the field named field (or the table's first field if the field argument is missing).

If the initial argument is a numerical value, returns the minimum of first and second.

Double

Yes

Yes

mode(DataTable table, String field)

Returns the mode of the values in a field in table. Target field name is specified by field.

Double

Yes

Yes

ne(Long first, Long second)

Returns true if first argument is not equal to the second argument (same as != operator).

Boolean

Yes

Yes

pi()

Returns the ratio of the circumference of a circle to its diameter.

Double

Yes

Yes

pow(Double base, Double power)

Returns the value of the first argument raised to the power of the second argument.

Double

Yes

Yes

random()

Returns a value with a positive sign, greater than or equal to 0.0 and less than 1.0. Returned values are chosen pseudorandomly with (approximately) uniform distribution from that range.

Double

Yes

Yes

round(Double value)

Returns the closest integer to the argument.

Long

Yes

Yes

signum(Double value)

Returns the signum function of the argument; zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.

If argument type is Integer or Long, return value is Long.

Double

Yes

Yes

sin(Double value)

Returns the trigonometric sine of an angle. Angle is measured in radians.

Double

Yes

Yes

sinh(Double value)

Returns the hyperbolic sine of a value.

Double

Yes

Yes

sma(Data Table table, String field, Integer depth)

Returns a data table with the simple moving average calculated from the values in a field in table. Target field name is specified by field. The argument depth indicates how many previous values should be included in the average calculation window.

Returns data table with fields:

• Field - The values from the specified field of the table argument

• Average - moving average calculated based on the previous depth values from the Field column. The first (depth - 1) rows will have no value for Average.

Data Table

Yes

Yes

smm(Data Table table, String field, Integer depth)

Returns a data table with the simple moving median calculated from the values in a field in table. Field name is specified by field. The argument depth indicates how many previous values should be included in the median calculation window.

Returns data table with fields:

• Field - The values from the specified field of the table argument

• Median - moving median calculated based on the previous depth values from the Field column. The first (depth - 1) rows will have no value for Median.

Data Table

Yes

Yes

sqrt(Double value)

Returns the correctly rounded positive square root of a value.

Double

Yes

Yes

standardDeviation(DataTable table [, String field])

Returns the standard deviation calculated from the values in a field in table. Target field name is specified by the field parameter, if no field is provided then the first field is used.

Double

Yes

Yes

standardError(DataTable table [, String field])

Returns the standard error of the mean calculated from the values in a field in table. Target field name is specified by the field parameter, if no field is provided then the first field is used.

Double

Yes

Yes

sum(DataTable table, String field)

Returns the sum of the values in a field in table. Target field name is specified by field parameter, if no field is provided then the first field is used.

Double

Yes

Yes

tan(Double value)

Returns the trigonometric tangent of an angle. Angle is measured in radians.

Double

Yes

Yes

tanh(Double value)

Returns the hyperbolic tangent of a value.

Double

Yes

Yes

variance(DataTable table [, String field])

Returns the variance of the numbers from a field in table. Target field name is specified by field parameter, if no field is provided then the first field is used.

Double

Yes

Yes