Packages

t

com.nvidia.spark.rapids

GpuAggregateWindowFunction

trait GpuAggregateWindowFunction extends Expression with GpuWindowFunction

GPU Counterpart of AggregateWindowFunction. On the CPU this would extend DeclarativeAggregate and use the provided methods to build up the expressions need to produce a result. For window operations we do it in a single pass, where all of the data is available so instead we have out own set of expressions.

Linear Supertypes
GpuWindowFunction, ShimExpression, GpuUnevaluable, GpuExpression, Expression, TreeNode[Expression], Product, Equals, AnyRef, Any
Known Subclasses
GpuLag, GpuLead, GpuOffsetWindowFunction, GpuBasicDecimalSum, GpuBasicMax, GpuBasicMin, GpuBasicSum, GpuCollectBase, GpuCollectList, GpuCollectSet, GpuCount, GpuDecimal128Sum, GpuDecimalSum, GpuFirst, GpuFloatMax, GpuFloatMin, GpuLast, GpuMax, GpuMin, GpuNthValue, GpuSum, WindowStddevSamp, GpuPythonFunction, GpuPythonUDAF, GpuPythonUDF
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuAggregateWindowFunction
  2. GpuWindowFunction
  3. ShimExpression
  4. GpuUnevaluable
  5. GpuExpression
  6. Expression
  7. TreeNode
  8. Product
  9. Equals
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def children: Seq[Expression]
    Definition Classes
    TreeNode
  3. abstract def dataType: DataType
    Definition Classes
    Expression
  4. abstract def nullable: Boolean
    Definition Classes
    Expression
  5. abstract def productArity: Int
    Definition Classes
    Product
  6. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  7. abstract def windowAggregation(inputs: Seq[(ColumnVector, Int)]): RollingAggregationOnColumn

    Create the aggregation operation to perform for Windowing.

    Create the aggregation operation to perform for Windowing. The input to this method is a sequence of (index, ColumnVector) that corresponds one to one with what was returned by windowInputProjection. The index is the index into the Table for the corresponding ColumnVector. Some aggregations need extra values.

  8. abstract val windowInputProjection: Seq[Expression]

    Using child references, define the shape of the vectors sent to the window operations

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. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  5. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  6. def asCode: String
    Definition Classes
    TreeNode
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. lazy val canonicalized: Expression
    Definition Classes
    GpuExpression → Expression
  9. def checkInputDataTypes(): TypeCheckResult
    Definition Classes
    Expression
  10. def childrenResolved: Boolean
    Definition Classes
    Expression
  11. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  12. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  13. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  14. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  15. 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
  16. 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
  17. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  18. 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
  19. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  20. lazy val deterministic: Boolean
    Definition Classes
    Expression
  21. 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
  22. 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
  23. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  26. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  27. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  30. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  31. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  32. def foldable: Boolean
    Definition Classes
    Expression
  33. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  34. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  35. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  36. 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
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  38. 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
  39. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  40. 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
  41. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  42. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  45. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  46. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  47. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  48. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. def nodeName: String
    Definition Classes
    TreeNode
  51. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. def numberedTreeString: String
    Definition Classes
    TreeNode
  54. val origin: Origin
    Definition Classes
    TreeNode
  55. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  56. def p(number: Int): Expression
    Definition Classes
    TreeNode
  57. def prettyJson: String
    Definition Classes
    TreeNode
  58. def prettyName: String
    Definition Classes
    Expression
  59. def productIterator: Iterator[Any]
    Definition Classes
    Product
  60. def productPrefix: String
    Definition Classes
    Product
  61. def references: AttributeSet
    Definition Classes
    Expression
  62. lazy val resolved: Boolean
    Definition Classes
    Expression
  63. 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
  64. 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
  65. def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  66. def semanticHash(): Int
    Definition Classes
    Expression
  67. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  68. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  69. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  70. def sql: String
    Definition Classes
    Expression
  71. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  72. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  73. def toJSON: String
    Definition Classes
    TreeNode
  74. def toString(): String
    Definition Classes
    Expression → TreeNode → AnyRef → Any
  75. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  76. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  77. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  78. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  79. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  80. final def treeString: String
    Definition Classes
    TreeNode
  81. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  82. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  83. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  84. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  87. def windowOutput(result: ColumnVector): ColumnVector

    Do a final pass over the window aggregation output.

    Do a final pass over the window aggregation output. This lets us cast the result to a desired type or check for overflow. This is not used for GpuRunningWindowFunction. There you can use scanCombine.

  88. def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode

Inherited from GpuWindowFunction

Inherited from ShimExpression

Inherited from GpuUnevaluable

Inherited from GpuExpression

Inherited from Expression

Inherited from TreeNode[Expression]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped