pyspark.sql.functions.signum

pyspark.sql.functions.signum(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

>>> df = spark.range(1)
>>> df.select(signum(lit(-5))).show()
+----------+
|SIGNUM(-5)|
+----------+
|      -1.0|
+----------+
>>> df.select(signum(lit(6))).show()
+---------+
|SIGNUM(6)|
+---------+
|      1.0|
+---------+