mod

Typeoperator
DictionaryLCS
LibraryLiveCode Script
Syntax
<number> mod <divisor>
Summary

Evaluates to the remainder left over when one number is divided by another.

Introduced1.0
Changes

The option to divide arrays was introduced in version 1.1. In previous versions, only single numbers could be used with the mod operator.

OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Parameters
NameTypeDescription
number

A number, or an expression that evaluates to a number, or an array containing only numbers.

divisor

Any non-zero number. If the number is an array, the divisor is either a non-zero number or an array containing only non-zero numbers.

Example
23 mod 5 -- evaluates to 3 (23 div 5 is 4, with 3 left over)
12 mod 4 -- evaluates to zero
23 mod -5 -- evaluates to 3
Values
NameTypeDescription
The result

*Note:* Using non-integer number and divisor usually produces sensible results. However, mathematically, modulus is generally defined as a function over the integers, and the results using non-integers may not consistently be what you expect.

RelatedKeyword: element
Glossary: operator, remainder, array, element, expression, math operation
Operator: /
Description

Use the mod operator to perform modulus arithmetic.

If the number to be divided is an array, each of the array elements must be a number. If an array is divided by a number, each element is divided by the number. If an array is divided by an array, both arrays must have the same number of elements and the same dimension, and each element in one array is divided by the corresponding element of the other array.

If an element of an array is empty, the mod operator treats its contents as zero.

If number can be divided evenly into divisor, the expression number mod divisor is zero.

If a math operation on finite inputs produces a non-finite output, an execution error is thrown. See math operations for more information.

Tagsmath