Skip to main content

This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Previous sectionNext section


Returns an integer indicating the sign of a number.




The number argument can be any valid numeric expression.


The Sgn function has the following return values:

If Number Is Sgn Returns
Greater than zero 1
Equal to zero 0
Less than zero –1

The sign of the number argument determines the return value of the Sgn function. If number is the empty string ("") or a non-numeric value, Sgn returns 0. Sgn resolves multiple sign values; for example, --7 is equivalent to +7, and thus returns 1.


The following example uses the Sgn function to determine the sign of a number:

Dim MyVar1, MyVar2, MyVar3
MyVar1 = 12: MyVar2 = -2.4: MyVar3 = 0
Println Sgn(MyVar1)    ' Returns 1.
Println Sgn(MyVar2)    ' Returns -1.
Println Sgn(MyVar3)    ' Returns 0.
Println Sgn("")        ' Returns 0.
Println Sgn("a")       ' Returns 0.
Copy code to clipboard

See Also