cboumalh commented on code in PR #52883: URL: https://github.com/apache/spark/pull/52883#discussion_r2620527231
########## sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/tuplesketchesExpressions.scala: ########## @@ -0,0 +1,1358 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.spark.sql.catalyst.expressions + +import org.apache.datasketches.tuple.{AnotB, Intersection, Summary, SummarySetOperations, TupleSketchIterator, Union} +import org.apache.datasketches.tuple.adouble.{DoubleSummary, DoubleSummaryFactory, DoubleSummarySetOperations} +import org.apache.datasketches.tuple.aninteger.{IntegerSummary, IntegerSummaryFactory, IntegerSummarySetOperations} +import org.apache.datasketches.tuple.strings.{ArrayOfStringsSummary, ArrayOfStringsSummaryFactory, ArrayOfStringsSummarySetOperations} + +import org.apache.spark.sql.catalyst.analysis.ExpressionBuilder +import org.apache.spark.sql.catalyst.expressions.codegen.CodegenFallback +import org.apache.spark.sql.catalyst.plans.logical.{FunctionSignature, InputParameter} +import org.apache.spark.sql.catalyst.util.ThetaSketchUtils +import org.apache.spark.sql.internal.types.StringTypeWithCollation +import org.apache.spark.sql.types.{AbstractDataType, BinaryType, DataType, DoubleType, IntegerType, LongType} +import org.apache.spark.unsafe.types.UTF8String + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(child) - Returns the estimated number of unique values + given the binary representation of a Datasketches TupleSketch. The sketch's + summary type must be a double. """, + examples = """ + Examples: + > SELECT _FUNC_(tuple_sketch_agg_double(key, summary)) FROM VALUES (1, 1.0D), (1, 2.0D), (2, 3.0D) tab(key, summary); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleSketchEstimateDouble(child: Expression) + extends UnaryExpression + with CodegenFallback + with ExpectsInputTypes { + + override def nullIntolerant: Boolean = true + + override def inputTypes: Seq[AbstractDataType] = Seq(BinaryType) + + override def dataType: DataType = DoubleType + + override def prettyName: String = "tuple_sketch_estimate_double" + + override protected def withNewChildInternal(newChild: Expression): TupleSketchEstimateDouble = + copy(child = newChild) + + override def nullSafeEval(input: Any): Any = { + val buffer = input.asInstanceOf[Array[Byte]] + val sketch = ThetaSketchUtils.heapifyDoubleTupleSketch(buffer, prettyName) + sketch.getEstimate() + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(child) - Returns the estimated number of unique values + given the binary representation of a Datasketches TupleSketch. The sketch's + summary type must be an integer. """, + examples = """ + Examples: + > SELECT _FUNC_(tuple_sketch_agg_integer(key, summary)) FROM VALUES (1, 1), (1, 2), (2, 3) tab(key, summary); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleSketchEstimateInteger(child: Expression) + extends UnaryExpression + with CodegenFallback + with ExpectsInputTypes { + + override def nullIntolerant: Boolean = true + + override def inputTypes: Seq[AbstractDataType] = Seq(BinaryType) + + override def dataType: DataType = DoubleType + + override def prettyName: String = "tuple_sketch_estimate_integer" + + override protected def withNewChildInternal(newChild: Expression): TupleSketchEstimateInteger = + copy(child = newChild) + + override def nullSafeEval(input: Any): Any = { + val buffer = input.asInstanceOf[Array[Byte]] + val sketch = ThetaSketchUtils.heapifyIntegerTupleSketch(buffer, prettyName) + sketch.getEstimate() + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(child) - Returns the estimated number of unique values + given the binary representation of a Datasketches TupleSketch. The sketch's + summary type be a string or array of strings. """, + examples = """ + Examples: + > SELECT _FUNC_(tuple_sketch_agg_string(key, summary)) FROM VALUES (1, 'a'), (1, 'b'), (2, 'c') tab(key, summary); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleSketchEstimateString(child: Expression) + extends UnaryExpression + with CodegenFallback + with ExpectsInputTypes { + + override def nullIntolerant: Boolean = true + + override def inputTypes: Seq[AbstractDataType] = Seq(BinaryType) + + override def dataType: DataType = DoubleType + + override def prettyName: String = "tuple_sketch_estimate_string" + + override protected def withNewChildInternal(newChild: Expression): TupleSketchEstimateString = + copy(child = newChild) + + override def nullSafeEval(input: Any): Any = { + val buffer = input.asInstanceOf[Array[Byte]] + val sketch = ThetaSketchUtils.heapifyStringTupleSketch(buffer, prettyName) + sketch.getEstimate() + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(child, mode) - Aggregates the summary values from a double summary type + Datasketches TupleSketch. The mode can be 'sum', 'min', 'max', or 'alwaysone' + (defaults to 'sum'). """, + examples = """ + Examples: + > SELECT _FUNC_(tuple_sketch_agg_double(key, summary)) FROM VALUES (1, 1.0D), (1, 2.0D), (2, 3.0D) tab(key, summary); + 6.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleSketchSummaryDouble(left: Expression, right: Expression) + extends BinaryExpression + with CodegenFallback + with ExpectsInputTypes { + + def this(child: Expression) = { + this(child, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def nullIntolerant: Boolean = true + + override def inputTypes: Seq[AbstractDataType] = + Seq(BinaryType, StringTypeWithCollation(supportsTrimCollation = true)) + + override def dataType: DataType = DoubleType + + override def prettyName: String = "tuple_sketch_summary_double" + + override protected def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression): TupleSketchSummaryDouble = + copy(left = newFirst, right = newSecond) + + override def nullSafeEval(input: Any, modeInput: Any): Any = { + val buffer = input.asInstanceOf[Array[Byte]] + val mode = modeInput.asInstanceOf[UTF8String].toString + + ThetaSketchUtils.checkMode(mode, prettyName) + + val sketch = ThetaSketchUtils.heapifyDoubleTupleSketch(buffer, prettyName) + + ThetaSketchUtils.aggregateNumericSummaries[DoubleSummary, Double]( + sketch.iterator(), + mode, + (it: TupleSketchIterator[DoubleSummary]) => it.getSummary.getValue) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(child, mode) - Aggregates the summary values from a integer summary type + Datasketches TupleSketch. The mode can be 'sum', 'min', 'max', or 'alwaysone' + (defaults to 'sum'). """, + examples = """ + Examples: + > SELECT _FUNC_(tuple_sketch_agg_integer(key, summary)) FROM VALUES (1, 1), (1, 2), (2, 3) tab(key, summary); + 6 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleSketchSummaryInteger(left: Expression, right: Expression) + extends BinaryExpression + with CodegenFallback + with ExpectsInputTypes { + + def this(child: Expression) = { + this(child, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def nullIntolerant: Boolean = true + + override def inputTypes: Seq[AbstractDataType] = + Seq(BinaryType, StringTypeWithCollation(supportsTrimCollation = true)) + + override def dataType: DataType = LongType + + override def prettyName: String = "tuple_sketch_summary_integer" + + override protected def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression): TupleSketchSummaryInteger = + copy(left = newFirst, right = newSecond) + + override def nullSafeEval(input: Any, modeInput: Any): Any = { + val buffer = input.asInstanceOf[Array[Byte]] + val mode = modeInput.asInstanceOf[UTF8String].toString + + ThetaSketchUtils.checkMode(mode, prettyName) + + val sketch = ThetaSketchUtils.heapifyIntegerTupleSketch(buffer, prettyName) + + ThetaSketchUtils.aggregateNumericSummaries[IntegerSummary, Long]( + sketch.iterator(), + mode, + (it: TupleSketchIterator[IntegerSummary]) => it.getSummary.getValue.toLong) + } +} + +case class TupleUnionDouble( + first: Expression, + second: Expression, + third: Expression, + fourth: Expression) + extends TupleUnionBase[DoubleSummary, DoubleSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this( + first, + second, + Literal(ThetaSketchUtils.DEFAULT_LG_NOM_LONGS), + Literal(ThetaSketchUtils.MODE_SUM)) + } + + def this(first: Expression, second: Expression, third: Expression) = { + this(first, second, third, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression, + newFourth: Expression): TupleUnionDouble = + copy(first = newFirst, second = newSecond, third = newThird, fourth = newFourth) + + override def prettyName: String = "tuple_union_double" + + override protected def getModeFromString(modeString: String): DoubleSummary.Mode = + ThetaSketchUtils.getDoubleSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: DoubleSummary.Mode): SummarySetOperations[DoubleSummary] = + new DoubleSummarySetOperations(mode) + + override protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[DoubleSummary], + mode: DoubleSummary.Mode): Unit = { + val tupleSketch1 = ThetaSketchUtils.heapifyDoubleTupleSketch(sketch1Bytes, prettyName) + val tupleSketch2 = ThetaSketchUtils.heapifyDoubleTupleSketch(sketch2Bytes, prettyName) + + union.union(tupleSketch1) + union.union(tupleSketch2) + } +} + +case class TupleUnionThetaDouble( + first: Expression, + second: Expression, + third: Expression, + fourth: Expression) + extends TupleUnionBase[DoubleSummary, DoubleSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this( + first, + second, + Literal(ThetaSketchUtils.DEFAULT_LG_NOM_LONGS), + Literal(ThetaSketchUtils.MODE_SUM)) + } + + def this(first: Expression, second: Expression, third: Expression) = { + this(first, second, third, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression, + newFourth: Expression): TupleUnionThetaDouble = + copy(first = newFirst, second = newSecond, third = newThird, fourth = newFourth) + + override def prettyName: String = "tuple_union_theta_double" + + override protected def getModeFromString(modeString: String): DoubleSummary.Mode = + ThetaSketchUtils.getDoubleSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: DoubleSummary.Mode): SummarySetOperations[DoubleSummary] = + new DoubleSummarySetOperations(mode) + + override protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[DoubleSummary], + mode: DoubleSummary.Mode): Unit = { + val tupleSketch = ThetaSketchUtils.heapifyDoubleTupleSketch(sketch1Bytes, prettyName) + val thetaSketch = ThetaSketchUtils.wrapCompactSketch(sketch2Bytes, prettyName) + + val defaultSummary = new DoubleSummaryFactory(mode).newSummary() + + union.union(tupleSketch) + union.union(thetaSketch, defaultSummary) + } +} + +case class TupleUnionInteger( + first: Expression, + second: Expression, + third: Expression, + fourth: Expression) + extends TupleUnionBase[IntegerSummary, IntegerSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this( + first, + second, + Literal(ThetaSketchUtils.DEFAULT_LG_NOM_LONGS), + Literal(ThetaSketchUtils.MODE_SUM)) + } + + def this(first: Expression, second: Expression, third: Expression) = { + this(first, second, third, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression, + newFourth: Expression): TupleUnionInteger = + copy(first = newFirst, second = newSecond, third = newThird, fourth = newFourth) + + override def prettyName: String = "tuple_union_integer" + + override protected def getModeFromString(modeString: String): IntegerSummary.Mode = + ThetaSketchUtils.getIntegerSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: IntegerSummary.Mode): SummarySetOperations[IntegerSummary] = + new IntegerSummarySetOperations(mode, mode) + + override protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[IntegerSummary], + mode: IntegerSummary.Mode): Unit = { + val tupleSketch1 = ThetaSketchUtils.heapifyIntegerTupleSketch(sketch1Bytes, prettyName) + val tupleSketch2 = ThetaSketchUtils.heapifyIntegerTupleSketch(sketch2Bytes, prettyName) + + union.union(tupleSketch1) + union.union(tupleSketch2) + } +} + +case class TupleUnionThetaInteger( + first: Expression, + second: Expression, + third: Expression, + fourth: Expression) + extends TupleUnionBase[IntegerSummary, IntegerSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this( + first, + second, + Literal(ThetaSketchUtils.DEFAULT_LG_NOM_LONGS), + Literal(ThetaSketchUtils.MODE_SUM)) + } + + def this(first: Expression, second: Expression, third: Expression) = { + this(first, second, third, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression, + newFourth: Expression): TupleUnionThetaInteger = + copy(first = newFirst, second = newSecond, third = newThird, fourth = newFourth) + + override def prettyName: String = "tuple_union_theta_integer" + + override protected def getModeFromString(modeString: String): IntegerSummary.Mode = + ThetaSketchUtils.getIntegerSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: IntegerSummary.Mode): SummarySetOperations[IntegerSummary] = + new IntegerSummarySetOperations(mode, mode) + + override protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[IntegerSummary], + mode: IntegerSummary.Mode): Unit = { + val tupleSketch = ThetaSketchUtils.heapifyIntegerTupleSketch(sketch1Bytes, prettyName) + val thetaSketch = ThetaSketchUtils.wrapCompactSketch(sketch2Bytes, prettyName) + + val defaultSummary = new IntegerSummaryFactory(mode).newSummary() + + union.union(tupleSketch) + union.union(thetaSketch, defaultSummary) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch1, tupleSketch2, lgNomEntries) - Merges two binary representations of Datasketches + TupleSketch objects with string or array of strings summary data type using a TupleSketch Union + object. Users can set lgNomEntries to a value between 4 and 26 (defaults to 12). """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_string(_FUNC_(tuple_sketch_agg_string(col1, val1), tuple_sketch_agg_string(col2, val2))) FROM VALUES (1, 'a', 4, 'x'), (2, 'b', 5, 'y'), (3, 'c', 6, 'z') tab(col1, val1, col2, val2); + 6.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleUnionString(first: Expression, second: Expression, third: Expression) + extends TupleUnionNoModeBase[ArrayOfStringsSummary] { + + def this(first: Expression, second: Expression) = { + this(first, second, Literal(ThetaSketchUtils.DEFAULT_LG_NOM_LONGS)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression): TupleUnionString = + copy(first = newFirst, second = newSecond, third = newThird) + + override def prettyName: String = "tuple_union_string" + + override protected def createSummarySetOperations() + : SummarySetOperations[ArrayOfStringsSummary] = + new ArrayOfStringsSummarySetOperations() + + override protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[ArrayOfStringsSummary]): Unit = { + val tupleSketch1 = ThetaSketchUtils.heapifyStringTupleSketch(sketch1Bytes, prettyName) + val tupleSketch2 = ThetaSketchUtils.heapifyStringTupleSketch(sketch2Bytes, prettyName) + + union.union(tupleSketch1) + union.union(tupleSketch2) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch, thetaSketch, lgNomEntries) - Merges the binary representation of a + Datasketches TupleSketch with string or array of strings summary data type with the binary + representation of a Datasketches ThetaSketch using a TupleSketch Union object. The ThetaSketch + entries are assigned a default string summary value. Users can set lgNomEntries to a value between + 4 and 26 (defaults to 12). """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_string(_FUNC_(tuple_sketch_agg_string(col1, val1), theta_sketch_agg(col2))) FROM VALUES (1, 'a', 4), (2, 'b', 5), (3, 'c', 6) tab(col1, val1, col2); + 6.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleUnionThetaString(first: Expression, second: Expression, third: Expression) + extends TupleUnionNoModeBase[ArrayOfStringsSummary] { + + def this(first: Expression, second: Expression) = { + this(first, second, Literal(ThetaSketchUtils.DEFAULT_LG_NOM_LONGS)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression): TupleUnionThetaString = + copy(first = newFirst, second = newSecond, third = newThird) + + override def prettyName: String = "tuple_union_theta_string" + + override protected def createSummarySetOperations() + : SummarySetOperations[ArrayOfStringsSummary] = + new ArrayOfStringsSummarySetOperations() + + override protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[ArrayOfStringsSummary]): Unit = { + val tupleSketch = ThetaSketchUtils.heapifyStringTupleSketch(sketch1Bytes, prettyName) + val thetaSketch = ThetaSketchUtils.wrapCompactSketch(sketch2Bytes, prettyName) + + // This doesn't mean anything since there are no set operations for string variants + val defaultSummary = new ArrayOfStringsSummaryFactory().newSummary() + defaultSummary.update(Array.empty[String]) + + union.union(tupleSketch) + union.union(thetaSketch, defaultSummary) + } +} + +abstract class TupleUnionBase[S <: Summary, M] + extends QuaternaryExpression + with CodegenFallback + with ExpectsInputTypes { + + override def nullIntolerant: Boolean = true + + override def inputTypes: Seq[AbstractDataType] = + Seq( + BinaryType, + BinaryType, + IntegerType, + StringTypeWithCollation(supportsTrimCollation = true)) + + override def dataType: DataType = BinaryType + + protected def getModeFromString(modeString: String): M + + protected def createSummarySetOperations(mode: M): SummarySetOperations[S] + + protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[S], + mode: M): Unit + + override def nullSafeEval( + sketch1Binary: Any, + sketch2Binary: Any, + lgNomEntries: Any, + modeInput: Any): Any = { + + val logNominalEntries = lgNomEntries.asInstanceOf[Int] + ThetaSketchUtils.checkLgNomLongs(logNominalEntries, prettyName) + + val modeString = modeInput.asInstanceOf[UTF8String].toString + ThetaSketchUtils.checkMode(modeString, prettyName) + + val mode = getModeFromString(modeString) + val sketch1Bytes = sketch1Binary.asInstanceOf[Array[Byte]] + val sketch2Bytes = sketch2Binary.asInstanceOf[Array[Byte]] + + val nominalEntries = 1 << logNominalEntries + val summarySetOps = createSummarySetOperations(mode) + val union = new Union(nominalEntries, summarySetOps) + + unionSketches(sketch1Bytes, sketch2Bytes, union, mode) + + union.getResult.toByteArray + } +} + +abstract class TupleUnionNoModeBase[S <: Summary] + extends TernaryExpression + with CodegenFallback + with ExpectsInputTypes { + + override def nullIntolerant: Boolean = true + + override def inputTypes: Seq[AbstractDataType] = + Seq(BinaryType, BinaryType, IntegerType) + + override def dataType: DataType = BinaryType + + protected def createSummarySetOperations(): SummarySetOperations[S] + + protected def unionSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + union: Union[S]): Unit + + override def nullSafeEval(sketch1Binary: Any, sketch2Binary: Any, lgNomEntries: Any): Any = { + + val logNominalEntries = lgNomEntries.asInstanceOf[Int] + ThetaSketchUtils.checkLgNomLongs(logNominalEntries, prettyName) + + val sketch1Bytes = sketch1Binary.asInstanceOf[Array[Byte]] + val sketch2Bytes = sketch2Binary.asInstanceOf[Array[Byte]] + + val nominalEntries = 1 << logNominalEntries + val summarySetOps = createSummarySetOperations() + val union = new Union(nominalEntries, summarySetOps) + + unionSketches(sketch1Bytes, sketch2Bytes, union) + + union.getResult.toByteArray + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch1, tupleSketch2, mode) - Intersects two binary representations of Datasketches + TupleSketch objects with double summary data type using a TupleSketch Intersection object. + Users can set mode to 'sum', 'min', 'max', or 'alwaysone' (defaults to 'sum'). """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_double(_FUNC_(tuple_sketch_agg_double(col1, val1), tuple_sketch_agg_double(col2, val2))) FROM VALUES (1, 1.0D, 1, 4.0D), (2, 2.0D, 2, 5.0D), (3, 3.0D, 4, 6.0D) tab(col1, val1, col2, val2); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleIntersectionDouble(first: Expression, second: Expression, third: Expression) + extends TupleIntersectionBase[DoubleSummary, DoubleSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this(first, second, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression): TupleIntersectionDouble = + copy(first = newFirst, second = newSecond, third = newThird) + + override def prettyName: String = "tuple_intersection_double" + + override protected def getModeFromString(modeString: String): DoubleSummary.Mode = + ThetaSketchUtils.getDoubleSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: DoubleSummary.Mode): SummarySetOperations[DoubleSummary] = + new DoubleSummarySetOperations(mode) + + override protected def intersectSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + intersection: Intersection[DoubleSummary], + mode: DoubleSummary.Mode): Unit = { + val tupleSketch1 = ThetaSketchUtils.heapifyDoubleTupleSketch(sketch1Bytes, prettyName) + val tupleSketch2 = ThetaSketchUtils.heapifyDoubleTupleSketch(sketch2Bytes, prettyName) + + intersection.intersect(tupleSketch1) + intersection.intersect(tupleSketch2) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch, thetaSketch, mode) - Intersects the binary representation of a + Datasketches TupleSketch with double summary data type with the binary representation of a + Datasketches ThetaSketch using a TupleSketch Intersection object. The ThetaSketch entries are + assigned a default double summary value. Users can set mode to 'sum', 'min', 'max', or 'alwaysone' + (defaults to 'sum'). """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_double(_FUNC_(tuple_sketch_agg_double(col1, val1), theta_sketch_agg(col2))) FROM VALUES (1, 1.0D, 1), (2, 2.0D, 2), (3, 3.0D, 4) tab(col1, val1, col2); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleIntersectionThetaDouble(first: Expression, second: Expression, third: Expression) + extends TupleIntersectionBase[DoubleSummary, DoubleSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this(first, second, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression): TupleIntersectionThetaDouble = + copy(first = newFirst, second = newSecond, third = newThird) + + override def prettyName: String = "tuple_intersection_theta_double" + + override protected def getModeFromString(modeString: String): DoubleSummary.Mode = + ThetaSketchUtils.getDoubleSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: DoubleSummary.Mode): SummarySetOperations[DoubleSummary] = + new DoubleSummarySetOperations(mode) + + override protected def intersectSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + intersection: Intersection[DoubleSummary], + mode: DoubleSummary.Mode): Unit = { + val tupleSketch = ThetaSketchUtils.heapifyDoubleTupleSketch(sketch1Bytes, prettyName) + val thetaSketch = ThetaSketchUtils.wrapCompactSketch(sketch2Bytes, prettyName) + + val defaultSummary = new DoubleSummaryFactory(mode).newSummary() + + intersection.intersect(tupleSketch) + intersection.intersect(thetaSketch, defaultSummary) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch1, tupleSketch2, mode) - Intersects two binary representations of Datasketches + TupleSketch objects with integer summary data type using a TupleSketch Intersection object. + Users can set mode to 'sum', 'min', 'max', or 'alwaysone' (defaults to 'sum'). """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_integer(_FUNC_(tuple_sketch_agg_integer(col1, val1), tuple_sketch_agg_integer(col2, val2))) FROM VALUES (1, 1, 1, 4), (2, 2, 2, 5), (3, 3, 4, 6) tab(col1, val1, col2, val2); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleIntersectionInteger(first: Expression, second: Expression, third: Expression) + extends TupleIntersectionBase[IntegerSummary, IntegerSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this(first, second, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression): TupleIntersectionInteger = + copy(first = newFirst, second = newSecond, third = newThird) + + override def prettyName: String = "tuple_intersection_integer" + + override protected def getModeFromString(modeString: String): IntegerSummary.Mode = + ThetaSketchUtils.getIntegerSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: IntegerSummary.Mode): SummarySetOperations[IntegerSummary] = + new IntegerSummarySetOperations(mode, mode) + + override protected def intersectSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + intersection: Intersection[IntegerSummary], + mode: IntegerSummary.Mode): Unit = { + val tupleSketch1 = ThetaSketchUtils.heapifyIntegerTupleSketch(sketch1Bytes, prettyName) + val tupleSketch2 = ThetaSketchUtils.heapifyIntegerTupleSketch(sketch2Bytes, prettyName) + + intersection.intersect(tupleSketch1) + intersection.intersect(tupleSketch2) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch, thetaSketch, mode) - Intersects the binary representation of a + Datasketches TupleSketch with integer summary data type with the binary representation of a + Datasketches ThetaSketch using a TupleSketch Intersection object. The ThetaSketch entries are + assigned a default integer summary value. Users can set mode to 'sum', 'min', 'max', or 'alwaysone' + (defaults to 'sum'). """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_integer(_FUNC_(tuple_sketch_agg_integer(col1, val1), theta_sketch_agg(col2))) FROM VALUES (1, 1, 1), (2, 2, 2), (3, 3, 4) tab(col1, val1, col2); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleIntersectionThetaInteger(first: Expression, second: Expression, third: Expression) + extends TupleIntersectionBase[IntegerSummary, IntegerSummary.Mode] { + + def this(first: Expression, second: Expression) = { + this(first, second, Literal(ThetaSketchUtils.MODE_SUM)) + } + + override def withNewChildrenInternal( + newFirst: Expression, + newSecond: Expression, + newThird: Expression): TupleIntersectionThetaInteger = + copy(first = newFirst, second = newSecond, third = newThird) + + override def prettyName: String = "tuple_intersection_theta_integer" + + override protected def getModeFromString(modeString: String): IntegerSummary.Mode = + ThetaSketchUtils.getIntegerSummaryMode(modeString) + + override protected def createSummarySetOperations( + mode: IntegerSummary.Mode): SummarySetOperations[IntegerSummary] = + new IntegerSummarySetOperations(mode, mode) + + override protected def intersectSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + intersection: Intersection[IntegerSummary], + mode: IntegerSummary.Mode): Unit = { + val tupleSketch = ThetaSketchUtils.heapifyIntegerTupleSketch(sketch1Bytes, prettyName) + val thetaSketch = ThetaSketchUtils.wrapCompactSketch(sketch2Bytes, prettyName) + + val defaultSummary = new IntegerSummaryFactory(mode).newSummary() + + intersection.intersect(tupleSketch) + intersection.intersect(thetaSketch, defaultSummary) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch1, tupleSketch2) - Intersects two binary representations of Datasketches + TupleSketch objects with string or array of strings summary data type using a TupleSketch + Intersection object. """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_string(_FUNC_(tuple_sketch_agg_string(col1, val1), tuple_sketch_agg_string(col2, val2))) FROM VALUES (1, 'a', 1, 'x'), (2, 'b', 2, 'y'), (3, 'c', 4, 'z') tab(col1, val1, col2, val2); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleIntersectionString(left: Expression, right: Expression) + extends TupleIntersectionNoModeBase[ArrayOfStringsSummary] { + + override def withNewChildrenInternal( + newLeft: Expression, + newRight: Expression): TupleIntersectionString = + copy(left = newLeft, right = newRight) + + override def prettyName: String = "tuple_intersection_string" + + override protected def createSummarySetOperations() + : SummarySetOperations[ArrayOfStringsSummary] = + new ArrayOfStringsSummarySetOperations() + + override protected def intersectSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + intersection: Intersection[ArrayOfStringsSummary]): Unit = { + val tupleSketch1 = ThetaSketchUtils.heapifyStringTupleSketch(sketch1Bytes, prettyName) + val tupleSketch2 = ThetaSketchUtils.heapifyStringTupleSketch(sketch2Bytes, prettyName) + + intersection.intersect(tupleSketch1) + intersection.intersect(tupleSketch2) + } +} + +// scalastyle:off line.size.limit +@ExpressionDescription( + usage = """ + _FUNC_(tupleSketch, thetaSketch) - Intersects the binary representation of a + Datasketches TupleSketch with string or array of strings summary data type with the binary + representation of a Datasketches ThetaSketch using a TupleSketch Intersection object. The + ThetaSketch entries are assigned a default string summary value. """, + examples = """ + Examples: + > SELECT tuple_sketch_estimate_string(_FUNC_(tuple_sketch_agg_string(col1, val1), theta_sketch_agg(col2))) FROM VALUES (1, 'a', 1), (2, 'b', 2), (3, 'c', 4) tab(col1, val1, col2); + 2.0 + """, + group = "misc_funcs", + since = "4.2.0") +// scalastyle:on line.size.limit +case class TupleIntersectionThetaString(left: Expression, right: Expression) + extends TupleIntersectionNoModeBase[ArrayOfStringsSummary] { + + override def withNewChildrenInternal( + newLeft: Expression, + newRight: Expression): TupleIntersectionThetaString = + copy(left = newLeft, right = newRight) + + override def prettyName: String = "tuple_intersection_theta_string" + + override protected def createSummarySetOperations() + : SummarySetOperations[ArrayOfStringsSummary] = + new ArrayOfStringsSummarySetOperations() + + override protected def intersectSketches( + sketch1Bytes: Array[Byte], + sketch2Bytes: Array[Byte], + intersection: Intersection[ArrayOfStringsSummary]): Unit = { + val tupleSketch = ThetaSketchUtils.heapifyStringTupleSketch(sketch1Bytes, prettyName) + val thetaSketch = ThetaSketchUtils.wrapCompactSketch(sketch2Bytes, prettyName) + + // This doesn't mean anything since there are no set operations for string variants Review Comment: Yeah the string variant is a bit weird. We can associate a string array summary with each key, but there are no modes of aggregation. So if we have this `{("key", Array("a", "b", "c"))} ∪ {("key", Array("d", "e", "f"))}`, the result will simply be `{("key", Array("a", "b", "c"))}` instead of something like `{("key", Array("a", "b", "c", "d", "e", "f"))}`. I believe it doesn't hurt to keep it for 2 reasons. 1) If some Datasketches native operations is added in the future, most of the work will have already been done in this PR. 2) Users can technically create their filtering or merging logic on the string summary tuple sketch. So they can use the code in this pr to create a sketch, union, intersect, etc.. and then potentially have custom logic in a udf to do some specific merging/filtering of summaries (not the keys). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
