Numeric Functions

Integer Functions

The following standard functions (defined in the ArithmeticPackage but excluded if using a raw Engine) operate on i8, i16, i32, i64, f32, f64 and Decimal (requires decimal) only:

FunctionDescription
absabsolute value
signreturns (INT) −1 if negative, +1 if positive, 0 if zero

The following standard functions (defined in the BasicMathPackage but excluded if using a raw Engine) operate on integers only:

FunctionNot available underDescription
to_floatno_floatconvert the value into f64 (f32 under f32_float)
to_decimalnon-decimalconvert the value into Decimal

Floating-Point Functions

The following standard functions (defined in the BasicMathPackage but excluded if using a raw Engine) operate on f64 only (f32 under f32_float):

CategorySupports DecimalFunctions
Trigonometrynosin, cos, tan, sinh, cosh, tanh in radians, hypot(x,y)
Arc-trigonometrynoasin, acos, atan(v), atan(x,y), asinh, acosh, atanh in radians
Square rootyessqrt
Exponentialyesexp (base e)
Logarithmicyesln (base e)
Logarithmicnolog(x) in base 10, log(x,base)
Roundingyesfloor, ceiling, round, int, fraction methods and properties
Conversionyesto_int, to_decimal (requires decimal)
Conversionnoto_degrees, to_radians
Testingnois_nan, is_finite, is_infinite methods and properties

Decimal Rounding

The following rounding methods (defined in the BasicMathPackage but excluded if using a raw Engine) operate on Decimal only, which requires the decimal feature:

Rounding typeBehaviorMethods
Nonefloor, ceiling, int, fraction methods and properties
Banker’s roundinground to integerround method and property
Banker’s roundinground to specified number of decimal pointsround(decimal points)
Round upaway from zeroround_up(decimal points)
Round downtowards zeroround_down(decimal points)
Round half-upmid-point away from zeroround_half_up(decimal points)
Round half-downmid-point towards zeroround_half_down(decimal points)

Parsing Functions

The following standard functions (defined in the BasicMathPackage but excluded if using a raw Engine) parse numbers:

FunctionNo available underDescription
parse_intconverts a string to INT with an optional radix
parse_floatno_floatconverts a string to FLOAT
parse_decimalnon-decimalconverts a string to Decimal

Constants

The following functions return standard mathematical constants:

FunctionDescription
PIreturns the value of π
Ereturns the value of e