pyspark.sql.functions.vector_norm#

pyspark.sql.functions.vector_norm(vector, degree=None)[source]#

Returns the Lp norm of a float vector using the specified degree. Degree defaults to 2.0 (Euclidean norm) if unspecified.

Added in version 4.3.0.

Parameters:

vectorColumn or column name: input vector column.
degreeColumn or column name, optional: norm degree (1.0 for L1, 2.0 for L2, float(‘inf’) for infinity norm). Defaults to 2.0.

Returns:

Column: the Lp norm as a float value.

Examples

>>> from pyspark.sql import functions as sf
>>> from pyspark.sql.types import ArrayType, FloatType, StructType, StructField
>>> schema = StructType([StructField('v', ArrayType(FloatType()))])
>>> df = spark.createDataFrame([([3.0, 4.0],)], schema)
>>> df.select(sf.vector_norm('v', sf.lit(2.0).cast('float'))).first()[0]
5.0