Packages

c

org.apache.spark.sql.rapids

GpuDecimal128Average

case class GpuDecimal128Average(child: Expression, dt: DecimalType) extends GpuDecimalAverage with Product with Serializable

Average aggregations for DECIMAL128.

To avoid the significantly slower sort-based aggregations in cudf for DECIMAL128 columns, the incoming DECIMAL128 values are split into four 32-bit chunks which are summed separately into 64-bit intermediate results and then recombined into a 128-bit result with overflow checking. See GpuDecimal128Sum for more details.

Linear Supertypes
GpuDecimalAverage, GpuAverage, Serializable, Serializable, GpuReplaceWindowFunction, GpuWindowFunction, GpuAggregateFunction, GpuUnevaluable, ShimExpression, GpuExpression, Arm, Expression, TreeNode[Expression], TreePatternBits, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuDecimal128Average
  2. GpuDecimalAverage
  3. GpuAverage
  4. Serializable
  5. Serializable
  6. GpuReplaceWindowFunction
  7. GpuWindowFunction
  8. GpuAggregateFunction
  9. GpuUnevaluable
  10. ShimExpression
  11. GpuExpression
  12. Arm
  13. Expression
  14. TreeNode
  15. TreePatternBits
  16. Product
  17. Equals
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GpuDecimal128Average(child: Expression, dt: DecimalType)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val aggBufferAttributes: Seq[AttributeReference]

    This is the contract with the outside world.

    This is the contract with the outside world. It describes what the output of postUpdate should look like, and what the input to preMerge looks like. It also describes what the output of postMerge must look like.

    Definition Classes
    GpuAverage → GpuAggregateFunction
  5. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  6. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  7. def asCode: String
    Definition Classes
    TreeNode
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. lazy val canonicalized: Expression
    Definition Classes
    GpuExpression → Expression
  10. def checkInputDataTypes(): TypeCheckResult
    Definition Classes
    GpuAverage → Expression
  11. val child: Expression
  12. def children: Seq[Expression]
    Definition Classes
    GpuAverage → TreeNode
  13. def childrenResolved: Boolean
    Definition Classes
    Expression
  14. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  15. def closeOnExcept[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  16. def closeOnExcept[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  17. def closeOnExcept[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  18. def closeOnExcept[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block, closing the resources only if an exception occurs

    Executes the provided code block, closing the resources only if an exception occurs

    Definition Classes
    Arm
  19. def closeOnExcept[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, closing the resource only if an exception occurs

    Executes the provided code block, closing the resource only if an exception occurs

    Definition Classes
    Arm
  20. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  21. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  22. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  23. final def columnarEval(batch: ColumnarBatch): Any

    Returns the result of evaluating this expression on the entire ColumnarBatch.

    Returns the result of evaluating this expression on the entire ColumnarBatch. The result of calling this may be a single GpuColumnVector or a scalar value. Scalar values typically happen if they are a part of the expression i.e. col("a") + 100. In this case the 100 is a literal that Add would have to be able to handle.

    By convention any GpuColumnVector returned by columnarEval is owned by the caller and will need to be closed by them. This can happen by putting it into a ColumnarBatch and closing the batch or by closing the vector directly if it is a temporary value.

    Definition Classes
    GpuUnevaluable → GpuExpression
  24. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  25. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  26. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  27. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  28. def convertToAst(numFirstTableColumns: Int): AstExpression

    Build an equivalent representation of this expression in a cudf AST.

    Build an equivalent representation of this expression in a cudf AST.

    numFirstTableColumns

    number of columns in the leftmost input table. Spark places the columns of all inputs in a single sequence, while cudf AST uses an explicit table reference to make column indices unique. This parameter helps translate input column references from Spark's single sequence into cudf's separate sequences.

    returns

    top node of the equivalent AST

    Definition Classes
    GpuExpression
  29. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  30. lazy val count: AttributeReference
    Attributes
    protected
    Definition Classes
    GpuAverage
  31. val dataType: DecimalType
    Definition Classes
    GpuDecimalAverage → GpuAverage → Expression
  32. lazy val deterministic: Boolean
    Definition Classes
    Expression
  33. def disableCoalesceUntilInput(): Boolean

    Override this if your expression cannot allow combining of data from multiple files into a single batch before it operates on them.

    Override this if your expression cannot allow combining of data from multiple files into a single batch before it operates on them. These are for things like getting the input file name. Which for spark is stored in a thread local variable which means we have to jump through some hoops to make this work.

    Definition Classes
    GpuExpression
  34. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  35. val dt: DecimalType
  36. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  38. lazy val evaluateExpression: Expression

    This takes the output of postMerge computes the final result of the aggregation.

    This takes the output of postMerge computes the final result of the aggregation.

    Definition Classes
    GpuDecimalAverage → GpuAverage → GpuAggregateFunction
    Note

    evaluateExpression is bound to aggBufferAttributes, so the references used in evaluateExpression must also be used in aggBufferAttributes.

  39. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  40. def filteredInputProjection(filter: Expression): Seq[Expression]
    Definition Classes
    GpuAverage → GpuAggregateFunction
  41. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  42. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  43. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  44. final def foldable: Boolean

    An aggregate function is not foldable.

    An aggregate function is not foldable.

    Definition Classes
    GpuAggregateFunction → Expression
  45. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  46. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  47. def freeOnExcept[T <: RapidsBuffer, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Executes the provided code block, freeing the RapidsBuffer only if an exception occurs

    Definition Classes
    Arm
  48. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  49. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean, indent: Int): Unit
    Definition Classes
    TreeNode
  50. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  51. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  52. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  53. def hasSideEffects: Boolean

    Could evaluating this expression cause side-effects, such as throwing an exception?

    Could evaluating this expression cause side-effects, such as throwing an exception?

    Definition Classes
    GpuExpression
  54. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  55. lazy val initialValues: Seq[GpuLiteral]

    These are values that spark calls initial because it uses them to initialize the aggregation buffer, and returns them in case of an empty aggregate when there are no expressions.

    These are values that spark calls initial because it uses them to initialize the aggregation buffer, and returns them in case of an empty aggregate when there are no expressions.

    In our case they are only used in a very specific case: the empty input reduction case. In this case we don't have input to reduce, but we do have reduction functions, so each reduction function's initialValues is invoked to populate a single row of output.

    Definition Classes
    GpuAverage → GpuAggregateFunction
  56. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  57. lazy val inputProjection: Seq[Expression]

    Using the child reference, define the shape of input batches sent to the update expressions

    Using the child reference, define the shape of input batches sent to the update expressions

    Definition Classes
    GpuDecimal128Average → GpuAverage → GpuAggregateFunction
    Note

    this can be thought of as "pre" update: as update consumes its output in order

  58. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  59. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  60. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  61. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode
  62. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  63. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  64. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  65. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  66. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  67. lazy val mergeAggregates: Seq[CudfAggregate]

    merge: second half of the aggregation.

    merge: second half of the aggregation. Also used to merge multiple batches in the update or merge stages. These cuDF aggregates consume the output of preMerge. The sequence of CudfAggregate must match the shape of aggBufferAttributes, and care must be taken to ensure that each cuDF aggregate is able to work with the corresponding input (i.e. aggBufferAttributes[i] is the input to mergeAggregates[i]). If a transformation is required, preMerge can be used to mutate the batches before they arrive at mergeAggregates.

    Definition Classes
    GpuDecimal128Average → GpuDecimalAverage → GpuAverage → GpuAggregateFunction
  68. lazy val mergeCount: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  69. lazy val mergeIsOverflow: CudfMax
    Attributes
    protected
    Definition Classes
    GpuDecimalAverage
  70. lazy val mergeSum: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  71. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  72. def nodeName: String
    Definition Classes
    TreeNode
  73. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  74. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  76. def nullable: Boolean
    Definition Classes
    GpuAverage → Expression
  77. def numberedTreeString: String
    Definition Classes
    TreeNode
  78. val origin: Origin
    Definition Classes
    TreeNode
  79. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  80. def p(number: Int): Expression
    Definition Classes
    TreeNode
  81. lazy val postMerge: Seq[Expression]
    Definition Classes
    GpuDecimal128Average → GpuDecimalAverage → GpuAggregateFunction
  82. final lazy val postMergeAttr: Seq[AttributeReference]

    This is the last aggregation step, which optionally changes the result of the mergeAggregate.

    This is the last aggregation step, which optionally changes the result of the mergeAggregate. postMergeAttr: matches the order (and types) of mergeAggregates postMerge: binds to postMergeAttr and defines an expression that results in what Spark expects from the merge. We set this to postMergeAttr by default, for the pass through case (like in postUpdate). GpuM2 is the exception, where postMerge mutates the result of the mergeAggregates to output what Spark expects.

    Definition Classes
    GpuAggregateFunction
  83. lazy val postUpdate: Seq[Expression]
    Definition Classes
    GpuDecimal128Average → GpuDecimalAverage → GpuAggregateFunction
  84. final lazy val postUpdateAttr: Seq[AttributeReference]

    This is the last step in the update phase.

    This is the last step in the update phase. It can optionally modify the result of the cuDF update aggregates, or be a pass-through. postUpdateAttr: matches the order (and types) of updateAggregates postUpdate: binds to postUpdateAttr and defines an expression that results in what Spark expects from the update. By default this is postUpdateAttr, as it should match the shape of the Spark agg buffer leaving cuDF, but in the M2 and Count cases we overwrite it, because the cuDF shape isn't what Spark expects.

    Definition Classes
    GpuAggregateFunction
  85. lazy val preMerge: Seq[Expression]

    This step is the first step into the merge phase.

    This step is the first step into the merge phase. It can optionally modify the result of the postUpdate before it goes into the cuDF merge aggregation. preMerge: modify a partial batch to match the input required by a merge aggregate

    This always binds to aggBufferAttributes as that is the inbound schema for this aggregate from Spark. If it is set to aggBufferAttributes by default so the bind behaves like a pass through in most cases.

    Definition Classes
    GpuDecimal128Average → GpuDecimalAverage → GpuAggregateFunction
  86. def prettyJson: String
    Definition Classes
    TreeNode
  87. def prettyName: String
    Definition Classes
    GpuAverage → Expression
  88. def references: AttributeSet
    Definition Classes
    Expression
  89. lazy val resolved: Boolean
    Definition Classes
    Expression
  90. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  91. def semanticHash(): Int
    Definition Classes
    Expression
  92. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  93. def shouldReplaceWindow(spec: GpuWindowSpecDefinition): Boolean

    Return true if windowReplacement should be called to replace this GpuWindowFunction with something else.

    Return true if windowReplacement should be called to replace this GpuWindowFunction with something else.

    Definition Classes
    GpuReplaceWindowFunction
  94. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  95. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  96. def sql(isDistinct: Boolean): String
    Definition Classes
    GpuAggregateFunction
  97. def sql: String
    Definition Classes
    Expression
  98. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  99. lazy val sum: AttributeReference
    Attributes
    protected
    Definition Classes
    GpuAverage
  100. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  101. def toAggString(isDistinct: Boolean): String

    String representation used in explain plans.

    String representation used in explain plans.

    Definition Classes
    GpuAggregateFunction
  102. def toJSON: String
    Definition Classes
    TreeNode
  103. def toString(): String
    Definition Classes
    Expression → TreeNode → AnyRef → Any
  104. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  105. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  106. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  107. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  108. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  109. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  110. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  111. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  112. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  113. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  114. final def treeString: String
    Definition Classes
    TreeNode
  115. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  116. lazy val updateAggregates: Seq[CudfAggregate]

    update: first half of the aggregation The sequence of CudfAggregate must match the shape of inputProjections, and care must be taken to ensure that each cuDF aggregate is able to work with the corresponding inputProjection (i.e.

    update: first half of the aggregation The sequence of CudfAggregate must match the shape of inputProjections, and care must be taken to ensure that each cuDF aggregate is able to work with the corresponding inputProjection (i.e. inputProjection[i] is the input to updateAggregates[i]).

    Definition Classes
    GpuDecimal128Average → GpuAverage → GpuAggregateFunction
  117. lazy val updateCount: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  118. lazy val updateSum: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  119. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  120. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  121. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  122. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  123. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. def windowReplacement(spec: GpuWindowSpecDefinition): Expression

    Return a new single expression that can replace the existing aggregation in window calculations.

    Return a new single expression that can replace the existing aggregation in window calculations. Please note that this requires that there are no nested window operations. For example you cannot do a SUM of AVERAGES with this currently. That support may be added in the future.

    Definition Classes
    GpuDecimalAverage → GpuAverage → GpuReplaceWindowFunction
  125. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode
  126. def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Definition Classes
    ShimExpression → TreeNode
  127. def withResource[T <: AutoCloseable, V](h: CloseableHolder[T])(block: (CloseableHolder[T]) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  128. def withResource[T <: AutoCloseable, V](r: ArrayBuffer[T])(block: (ArrayBuffer[T]) ⇒ V): V

    Executes the provided code block and then closes the array buffer of resources

    Executes the provided code block and then closes the array buffer of resources

    Definition Classes
    Arm
  129. def withResource[T <: AutoCloseable, V](r: Array[T])(block: (Array[T]) ⇒ V): V

    Executes the provided code block and then closes the array of resources

    Executes the provided code block and then closes the array of resources

    Definition Classes
    Arm
  130. def withResource[T <: AutoCloseable, V](r: Seq[T])(block: (Seq[T]) ⇒ V): V

    Executes the provided code block and then closes the sequence of resources

    Executes the provided code block and then closes the sequence of resources

    Definition Classes
    Arm
  131. def withResource[T <: AutoCloseable, V](r: Option[T])(block: (Option[T]) ⇒ V): V

    Executes the provided code block and then closes the Option[resource]

    Executes the provided code block and then closes the Option[resource]

    Definition Classes
    Arm
  132. def withResource[T <: AutoCloseable, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the resource

    Executes the provided code block and then closes the resource

    Definition Classes
    Arm
  133. def withResourceIfAllowed[T, V](r: T)(block: (T) ⇒ V): V

    Executes the provided code block and then closes the value if it is AutoCloseable

    Executes the provided code block and then closes the value if it is AutoCloseable

    Definition Classes
    Arm

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from GpuDecimalAverage

Inherited from GpuAverage

Inherited from Serializable

Inherited from Serializable

Inherited from GpuReplaceWindowFunction

Inherited from GpuWindowFunction

Inherited from GpuAggregateFunction

Inherited from GpuUnevaluable

Inherited from ShimExpression

Inherited from GpuExpression

Inherited from Arm

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped