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

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