pyspark.sql.functions.sign

pyspark.sql.functions.sign(col: ColumnOrName) → pyspark.sql.column.Column[source]

Computes the signum of the given value.

New in version 1.4.0.

Changed in version 3.4.0: Supports Spark Connect.

Parameters
colColumn or str

target column to compute on.

Returns
Column

the column for computed results.

Examples

>>> import pyspark.sql.functions as sf
>>> spark.range(1).select(
...     sf.sign(sf.lit(-5)),
...     sf.sign(sf.lit(6))
... ).show()
+--------+-------+
|sign(-5)|sign(6)|
+--------+-------+
|    -1.0|    1.0|
+--------+-------+