mod (dividend divisor -- remainder)

Inputs

• dividend: Numeric value whose remainder is taken.
• divisor: Numeric value dividing the dividend to produce the remainder.

Outputs

• remainder: Remainder value.

mod computes the remainder of numeric division. Both inputs are dereferenced, must be non-NIL, and must have the same numeric schema.

Behavior

• For Int, the operation uses signed remainder semantics. The remainder follows the dividend sign.
• For Nat, the operation uses unsigned remainder semantics.
• For Real, the operation uses floating remainder semantics. The remainder likewise follows the dividend sign.
• If the divisor is known to be 0, the builtin is invalid.
• If both operands are known at compile time, the remainder is computed at compile time.
• If either operand is unknown, the result is an unknown value of the same numeric schema. An unknown divisor is allowed; only a known zero divisor is rejected.

Example

{} () {} [
  "-- int32 --" printCompilerMessage
  7 3 mod printStack _:;
  -7 3 mod printStack _:;
  7 -3 mod printStack _:;

  "-- nat32 --" printCompilerMessage
  7n32 3n32 mod printStack _:;

  "-- real32 --" printCompilerMessage
  7.5r32 2.0r32 mod printStack _:;
  -7.5r32 2.0r32 mod printStack _:;
  7.5r32 -2.0r32 mod printStack _:;

  "-- unknown divisor --" printCompilerMessage
  divisor: 3 dynamic;
  7 divisor mod printStack _:;
] "main" exportFunction

Expected Output During Compilation

-- int32 --
1
-1
1
-- nat32 --
1n32
-- real32 --
1.5r32
-1.5r32
1.5r32
-- unknown divisor --
Int32

See also

• / builtin (dividend divisor -- quotient) Divides numeric values within the same schema; Whole division stays whole, while Real schemas use floating division.