Commands

modulo

Supported By

XION Scripting Language Standard (1.0)
OpenXION (1.0, 1.1, 1.2, 1.3, 1.4)
OpenXION Standard Module (1.0, 1.1, 1.2, 1.3, 1.4)

Syntax

modulo container by number [rounding roundingMethod]

Number yields an integer, a number, or a complex. Container yields a container containing an integer, a number, or a complex. RoundingMethod is up, down, or to, toward, or towards zero, infinity, nearest, even, ceiling, or floor.

Examples

modulo steve by 17

modulo line 13 of bill by 100

Description

The modulo command divides the value of container by the value of number and leaves the remainder of the division in container. The value in the container must be an integer, a number, or a complex and is replaced with the new value.

Notes

The remainder is calculated as follows:

remainder = container - number * roundingFunction ( container / number )

where roundingFunction is the function listed in the table below.

If no roundingMethod is specified, to floor is assumed.

The following table shows the correspondences among the various roundingMethods, rounding functions, and division operators:

`rounding` parameter	function	operator	`java.math.RoundingMode`
`to ceiling`	`ceil`		`CEILING`
`to floor`	`floor`	`div` / `mod`	`FLOOR`
`up` / `to infinity`	`aug`		`UP`
`down` / `to zero`	`trunc`	`quot` / `rem`	`DOWN`
`to nearest`	`round`		`HALF_UP`
`to even`	`rint`		`HALF_EVEN`

See the ceil, floor, aug, trunc, round, and rint functions for descriptions of how these rounding methods work.