pyspark.sql.functions.kll_sketch_get_rank_double#

pyspark.sql.functions.kll_sketch_get_rank_double(sketch, quantile)[source]#

Extracts a rank value from a KLL double sketch given an input quantile value. The quantile can be a single value or an array.

New in version 4.1.0.

Parameters
sketchColumn or column name

The KLL double sketch binary representation

quantileColumn or column name

The quantile value(s) to lookup

Returns
Column

The rank value(s) (between 0.0 and 1.0).

Examples

>>> from pyspark.sql import functions as sf
>>> df = spark.createDataFrame([1.0,2.0,3.0,4.0,5.0], "DOUBLE")
>>> sketch_df = df.agg(sf.kll_sketch_agg_double("value").alias("sketch"))
>>> sketch_df.select(sf.kll_sketch_get_rank_double("sketch", sf.lit(3.0))).show()
+---------------------------------------+
|kll_sketch_get_rank_double(sketch, 3.0)|
+---------------------------------------+
|                                    0.6|
+---------------------------------------+