ee.Number.signum

  • The signum function returns 0 if the input is 0, 1 if it's greater than 0, and -1 if it's less than 0.

  • The Number.signum() usage returns a Number.

  • The input value for the signum function must be a Number.

 Computes the signum function (sign) of the input; 0 if the input is 0, 1 if the input is greater than 0, -1 if the input is less than 0.

UsageReturns
Number.signum()Number
ArgumentTypeDetails
this: inputNumberThe input value.

Examples

Code Editor (JavaScript)

print('Sign of -5', ee.Number(-5).signum());  // -1
print('Sign of 0', ee.Number(0).signum());  // 0
print('Sign of 5', ee.Number(5).signum());  // 1

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)

display('Sign of -5:', ee.Number(-5).signum())  # -1
display('Sign of 0:', ee.Number(0).signum())  # 0
display('Sign of 5:', ee.Number(5).signum())  # 1