pyspark.sql.functions.sign#

pyspark.sql.functions.sign(col)[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 column name: 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)),
...     sf.sign(sf.lit(float('nan'))),
...     sf.sign(sf.lit(None))
... ).show()
+--------+-------+---------+----------+
|sign(-5)|sign(6)|sign(NaN)|sign(NULL)|
+--------+-------+---------+----------+
|    -1.0|    1.0|      NaN|      NULL|
+--------+-------+---------+----------+