pyspark.sql.functions.kll_sketch_get_quantile_double#

pyspark.sql.functions.kll_sketch_get_quantile_double(sketch, rank)[source]#

Extracts a quantile value from a KLL double sketch given an input rank value. The rank 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
rankColumn or column name: The rank value(s) to extract (between 0.0 and 1.0)

Returns

Column: The quantile value(s).

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_quantile_double("sketch", sf.lit(0.5))).show()
+-------------------------------------------+
|kll_sketch_get_quantile_double(sketch, 0.5)|
+-------------------------------------------+
|                                        3.0|
+-------------------------------------------+