Packages

c

org.apache.spark.sql.rapids.aggregate

GpuDecimalAverage

abstract class GpuDecimalAverage extends GpuDecimalAverageBase

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

Instance Constructors

  1. new GpuDecimalAverage(child: Expression, sumDataType: DecimalType)

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def productArity: Int
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any
    Definition Classes
    Product

Concrete 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. def children: Seq[Expression]
    Definition Classes
    GpuAverage → TreeNode
  12. def childrenResolved: Boolean
    Definition Classes
    Expression
  13. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  14. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  15. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  16. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  17. final def columnarEval(batch: ColumnarBatch): GpuColumnVector

    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 is a GpuColumnVector.

    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
  18. final def columnarEvalAny(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 AutoCloseable returned by columnarEvalAny is owned by the caller and will need to be closed by them.

    Definition Classes
    GpuUnevaluable → GpuExpression
  19. final def containsAllPatterns(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  20. final def containsAnyPattern(patterns: TreePattern*): Boolean
    Definition Classes
    TreePatternBits
  21. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  22. final def containsPattern(t: TreePattern): Boolean
    Definition Classes
    TreePatternBits
    Annotations
    @inline()
  23. 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
  24. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  25. lazy val count: AttributeReference
    Attributes
    protected
    Definition Classes
    GpuAverage
  26. val dataType: DecimalType
    Definition Classes
    GpuDecimalAverageBase → GpuAverage → Expression
  27. lazy val deterministic: Boolean
    Definition Classes
    Expression
  28. 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
  29. def disableTieredProjectCombine: Boolean

    If this returns true then tiered project will stop looking to combine expressions when this is seen.

    If this returns true then tiered project will stop looking to combine expressions when this is seen.

    Definition Classes
    GpuExpression
  30. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  34. 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.

  35. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  36. def filteredInputProjection(filter: Expression): Seq[Expression]
    Definition Classes
    GpuAverage → GpuAggregateFunction
  37. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  39. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  40. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  41. final def foldable: Boolean

    An aggregate function is not foldable.

    An aggregate function is not foldable.

    Definition Classes
    GpuAggregateFunction → Expression
  42. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  43. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  44. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  45. 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
  46. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  47. def getDefaultTreePatternBits: BitSet
    Attributes
    protected
    Definition Classes
    TreeNode
  48. def getMinPeriods: Int

    Get "min-periods" value, i.e.

    Get "min-periods" value, i.e. the minimum number of periods/rows above which a non-null value is returned for the function. Otherwise, null is returned.

    returns

    Non-negative value for min-periods.

    Definition Classes
    GpuWindowFunction
  49. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  50. 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
  51. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  52. 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
  53. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  54. 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
    GpuAverage → GpuAggregateFunction
    Note

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

  55. lazy val intermediateSparkDivideType: DecimalType
    Definition Classes
    GpuDecimalAverageBase
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. def isRuleIneffective(ruleId: RuleId): Boolean
    Attributes
    protected
    Definition Classes
    TreeNode
  58. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  59. final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
    Attributes
    protected
    Definition Classes
    TreeNode
  60. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  61. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  62. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  63. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  64. def markRuleAsIneffective(ruleId: RuleId): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  65. 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
    GpuDecimalAverageBase → GpuAverage → GpuAggregateFunction
  66. lazy val mergeCount: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  67. lazy val mergeIsOverflow: CudfMax
    Attributes
    protected
    Definition Classes
    GpuDecimalAverageBase
  68. lazy val mergeSum: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  69. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. def nodeName: String
    Definition Classes
    TreeNode
  71. val nodePatterns: Seq[TreePattern]
    Attributes
    protected
    Definition Classes
    TreeNode
  72. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  74. def nullable: Boolean
    Definition Classes
    GpuAverage → Expression
  75. def numberedTreeString: String
    Definition Classes
    TreeNode
  76. val origin: Origin
    Definition Classes
    TreeNode
  77. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  78. def p(number: Int): Expression
    Definition Classes
    TreeNode
  79. lazy val postMerge: Seq[Expression]
    Definition Classes
    GpuDecimalAverageBase → GpuAggregateFunction
  80. 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
  81. lazy val postUpdate: Seq[Expression]
    Definition Classes
    GpuDecimalAverageBase → GpuAggregateFunction
  82. 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
  83. 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
    GpuDecimalAverageBase → GpuAggregateFunction
  84. def prettyJson: String
    Definition Classes
    TreeNode
  85. def prettyName: String
    Definition Classes
    GpuAverage → Expression
  86. def productIterator: Iterator[Any]
    Definition Classes
    Product
  87. def productPrefix: String
    Definition Classes
    Product
  88. def references: AttributeSet
    Definition Classes
    Expression
  89. lazy val resolved: Boolean
    Definition Classes
    Expression
  90. lazy val retryable: Boolean

    true means this expression can be used inside a retry block, otherwise false.

    true means this expression can be used inside a retry block, otherwise false. An expression is retryable when

    • it is deterministic, or
    • when being non-deterministic, it is a Retryable and its children are all retryable.
    Definition Classes
    GpuExpression
  91. val selfNonDeterministic: Boolean

    Whether an expression itself is non-deterministic when its "deterministic" is false, no matter whether it has any non-deterministic children.

    Whether an expression itself is non-deterministic when its "deterministic" is false, no matter whether it has any non-deterministic children. An expression is actually a tree, and deterministic being false means there is at least one tree node is non-deterministic, but we need to know the exact nodes which are non-deterministic to check if it implements the Retryable.

    Default to false because Spark checks only children by default in Expression. So it is non-deterministic iff it has non-deterministic children.

    NOTE When overriding "deterministic", this should be taken care of.

    Definition Classes
    GpuExpression
  92. final def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  93. def semanticHash(): Int
    Definition Classes
    Expression
  94. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  95. 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
  96. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  97. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  98. def sql(isDistinct: Boolean): String
    Definition Classes
    GpuAggregateFunction
  99. def sql: String
    Definition Classes
    Expression
  100. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  101. lazy val sum: AttributeReference
    Attributes
    protected
    Definition Classes
    GpuAverage
  102. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  103. def toAggString(isDistinct: Boolean): String

    String representation used in explain plans.

    String representation used in explain plans.

    Definition Classes
    GpuAggregateFunction
  104. def toJSON: String
    Definition Classes
    TreeNode
  105. def toString(): String
    Definition Classes
    Expression → TreeNode → AnyRef → Any
  106. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  107. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  108. def transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  109. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  110. def transformUpWithBeforeAndAfterRuleOnChildren(cond: (Expression) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
    Definition Classes
    TreeNode
  111. def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  112. def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId)(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  113. lazy val treePatternBits: BitSet
    Definition Classes
    TreeNode → TreePatternBits
  114. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  115. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  116. final def treeString: String
    Definition Classes
    TreeNode
  117. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  118. 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
    GpuAverage → GpuAggregateFunction
  119. lazy val updateCount: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  120. lazy val updateSum: CudfSum
    Attributes
    protected
    Definition Classes
    GpuAverage
  121. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  122. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  123. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  126. 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
  127. final def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode
  128. def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
    Definition Classes
    ShimExpression → TreeNode

Inherited from GpuDecimalAverageBase

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 Expression

Inherited from TreeNode[Expression]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped