ee.Number.mod

  • The mod method calculates the remainder of the first number divided by the second number.

  • The method takes two Number arguments, this: left and right, and returns a Number.

  • Examples are provided demonstrating the use of the mod method in both JavaScript and Python for both positive and negative dividends.

 Calculates the remainder of the first value divided by the second.

UsageReturns
Number.mod(right)Number
ArgumentTypeDetails
this: leftNumberThe left-hand value.
rightNumberThe right-hand value.

Examples

Code Editor (JavaScript)

// Remainder with positive dividend.
print('Remainder of 12/5', ee.Number(12).mod(ee.Number(5)));  // 2
print('Remainder of 1/-2', ee.Number(1).mod(ee.Number(-2)));  // 1
print('Remainder of 1/2', ee.Number(1).mod(ee.Number(2)));  // 1
print('Remainder of 2/3', ee.Number(2).mod(ee.Number(3)));  // 2
print('Remainder of 5.5/2', ee.Number(5.5).mod(ee.Number(2)));  // 1.5

// Remainder with negative dividend.
print('Remainder of -12/5', ee.Number(-12).mod(ee.Number(5)));  // -2
print('Remainder of -1/2', ee.Number(-1).mod(ee.Number(2)));  // -1
print('Remainder of -4/2', ee.Number(-4).mod(ee.Number(2)));  // 0

Python setup

See the Python Environment page for information on the Python API and using geemap for interactive development.

import ee
import geemap.core as geemap

Colab (Python)

# Remainder with positive dividend.
print('Remainder of 12/5:', ee.Number(12).mod(ee.Number(5)).getInfo())  # 2
print('Remainder of 1/-2:', ee.Number(1).mod(ee.Number(-2)).getInfo())  # 1
print('Remainder of 1/2:', ee.Number(1).mod(ee.Number(2)).getInfo())  # 1
print('Remainder of 2/3:', ee.Number(2).mod(ee.Number(3)).getInfo())  # 2
print('Remainder of 5.5/2:', ee.Number(5.5).mod(ee.Number(2)).getInfo())  # 1.5

# Remainder with negative dividend.
print('Remainder of -12/5:', ee.Number(-12).mod(ee.Number(5)).getInfo())  # -2
print('Remainder of -1/2:', ee.Number(-1).mod(ee.Number(2)).getInfo())  # -1
print('Remainder of -4/2:', ee.Number(-4).mod(ee.Number(2)).getInfo())  # 0