Round (Float function)

This intrinsic function returns a floating point number that is the method object number rounded to a specified number of decimal places.

The Round function is available as of version 7.6 of the Sirius Mods.

Round syntax

  %num = number:Round(dp)

Syntax terms

%num

A variable to receive the floating point result.

number

A Float value to be rounded to the number of decimal places specified in the method argument, dp.

dp

A numeric value that specifies the number of decimal places to which the input number is rounded. This value defaults to 0, and it must be between 0 and 75.

Usage Notes

• Negative numbers are rounded down to the nearest integer; positive numbers are rounded up.

Examples

The following program demonstrates the Round method.

  begin
  printText {~} = {3.1415926:round}
  printText {~} = {3.1415926:round(0)}
  printText {~} = {3.1415926:round(1)}
  printText {~} = {3.1415926:round(4)}
  end

The result is:

  3.1415926:round = 3
  3.1415926:round(0) = 3
  3.1415926:round(1) = 3.1
  3.1415926:round(4) = 3.1416

See also

List of Intrinsic Float Methods