Packages

case class GpuRank(children: Seq[Expression]) extends Expression with GpuRunningWindowFunction with GpuBatchedRunningWindowWithFixer with ShimExpression with Product with Serializable

Rank is a special window operation where it is only supported as a running window. In cudf it is only supported as a scan and a group by scan. But there are special requirements beyond that when doing the computation as a running batch. To fix up each batch it needs both the rank and the row number. To make this work and be efficient there is different behavior for batched running window vs non-batched. If it is for a running batch we include the row number values, in both the initial projections and in the corresponding aggregations. Then we combine them into a struct column in scanCombine before it is passed on to the RankFixer. If it is not a running batch, then we drop the row number part because it is just not needed.

children

the order by columns.

Note

this is a running window only operator.

Linear Supertypes
Serializable, Serializable, GpuBatchedRunningWindowWithFixer, GpuRunningWindowFunction, GpuWindowFunction, ShimExpression, GpuUnevaluable, GpuExpression, Expression, TreeNode[Expression], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GpuRank
  2. Serializable
  3. Serializable
  4. GpuBatchedRunningWindowWithFixer
  5. GpuRunningWindowFunction
  6. GpuWindowFunction
  7. ShimExpression
  8. GpuUnevaluable
  9. GpuExpression
  10. Expression
  11. TreeNode
  12. Product
  13. Equals
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GpuRank(children: Seq[Expression])

    children

    the order by columns.

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. val children: Seq[Expression]
    Definition Classes
    GpuRank → TreeNode
  11. def childrenResolved: Boolean
    Definition Classes
    Expression
  12. def clone(): Expression
    Definition Classes
    TreeNode → AnyRef
  13. def collect[B](pf: PartialFunction[Expression, B]): Seq[B]
    Definition Classes
    TreeNode
  14. def collectFirst[B](pf: PartialFunction[Expression, B]): Option[B]
    Definition Classes
    TreeNode
  15. def collectLeaves(): Seq[Expression]
    Definition Classes
    TreeNode
  16. 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
  17. 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
  18. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  19. 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
  20. def copyTagsFrom(other: Expression): Unit
    Definition Classes
    TreeNode
  21. def dataType: DataType
    Definition Classes
    GpuRank → Expression
  22. lazy val deterministic: Boolean
    Definition Classes
    Expression
  23. 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
  24. 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
  25. final def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
    Definition Classes
    GpuExpression → Expression
  26. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def eval(input: InternalRow = null): Any
    Definition Classes
    GpuExpression → Expression
  28. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  29. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def find(f: (Expression) ⇒ Boolean): Option[Expression]
    Definition Classes
    TreeNode
  31. def flatArguments: Iterator[Any]
    Attributes
    protected
    Definition Classes
    Expression
  32. def flatMap[A](f: (Expression) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  33. def foldable: Boolean
    Definition Classes
    Expression
  34. def foreach(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  35. def foreachUp(f: (Expression) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  36. def genCode(ctx: CodegenContext): ExprCode
    Definition Classes
    Expression
  37. 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
  38. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  39. 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
  40. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  41. def groupByScanAggregation(isRunningBatched: Boolean): Seq[AggAndReplace[GroupByScanAggregation]]

    Get the aggregations to perform on the results of groupByScanInputProjection.

    Get the aggregations to perform on the results of groupByScanInputProjection. The aggregations will be zipped with the values to produce the output.

    isRunningBatched

    is this for a batched running window that will use a fixer or not?

    returns

    the aggregations to perform as a group by scan.

    Definition Classes
    GpuRank → GpuRunningWindowFunction
  42. def groupByScanInputProjection(isRunningBatched: Boolean): Seq[Expression]

    Get the input projections for a group by scan.

    Get the input projections for a group by scan. This corresponds to a running window with a partition by clause. The partition keys will be used as the grouping keys.

    isRunningBatched

    is this for a batched running window that will use a fixer or not?

    returns

    the input expressions that will be aggregated using the result from groupByScanAggregation

    Definition Classes
    GpuRank → GpuRunningWindowFunction
  43. 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
  44. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  45. def innerChildren: Seq[TreeNode[_]]
    Definition Classes
    TreeNode
  46. def isGroupByScanSupported: Boolean

    Should a group by scan be run or not.

    Should a group by scan be run or not. This should never return false unless this is also an instance of GpuAggregateWindowFunction so the window code can fall back to it for computation.

    Definition Classes
    GpuRunningWindowFunction
  47. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  48. def isScanSupported: Boolean

    Should a scan be run or not.

    Should a scan be run or not. This should never return false unless this is also an instance of GpuAggregateWindowFunction so the window code can fall back to it for computation.

    Definition Classes
    GpuRunningWindowFunction
  49. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  50. def makeCopy(newArgs: Array[AnyRef]): Expression
    Definition Classes
    TreeNode
  51. def map[A](f: (Expression) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  52. def mapChildren(f: (Expression) ⇒ Expression): Expression
    Definition Classes
    TreeNode
  53. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  54. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  55. def newFixer(): BatchedRunningWindowFixer

    Get a new class that can be used to fix up batched running window operations.

    Get a new class that can be used to fix up batched running window operations.

    Definition Classes
    GpuRank → GpuBatchedRunningWindowWithFixer
  56. def nodeName: String
    Definition Classes
    TreeNode
  57. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  58. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. def nullable: Boolean
    Definition Classes
    GpuRank → Expression
  60. def numberedTreeString: String
    Definition Classes
    TreeNode
  61. val origin: Origin
    Definition Classes
    TreeNode
  62. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  63. def p(number: Int): Expression
    Definition Classes
    TreeNode
  64. def prettyJson: String
    Definition Classes
    TreeNode
  65. def prettyName: String
    Definition Classes
    Expression
  66. def references: AttributeSet
    Definition Classes
    Expression
  67. lazy val resolved: Boolean
    Definition Classes
    Expression
  68. 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
  69. def scanAggregation(isRunningBatched: Boolean): Seq[AggAndReplace[ScanAggregation]]

    Get the aggregations to perform on the results of scanInputProjection.

    Get the aggregations to perform on the results of scanInputProjection. The aggregations will be zipped with the values to produce the output.

    isRunningBatched

    is this for a batched running window that will use a fixer or not?

    returns

    the aggregations to perform as a group by scan.

    Definition Classes
    GpuRank → GpuRunningWindowFunction
  70. def scanCombine(isRunningBatched: Boolean, cols: Seq[ColumnVector]): ColumnVector

    Provides a way to combine the result of multiple aggregations into a final value.

    Provides a way to combine the result of multiple aggregations into a final value. By default it requires that there is a single aggregation and works as just a pass through.

    isRunningBatched

    is this for a batched running window that will use a fixer or not?

    cols

    the columns to be combined

    returns

    the result of combining these together.

    Definition Classes
    GpuRank → GpuRunningWindowFunction
  71. def scanInputProjection(isRunningBatched: Boolean): Seq[Expression]

    Get the input projections for a scan.

    Get the input projections for a scan. This corresponds to a running window without a partition by clause.

    isRunningBatched

    is this for a batched running window that will use a fixer or not?

    returns

    the input expressions that will be aggregated using the result from scanAggregation

    Definition Classes
    GpuRank → GpuRunningWindowFunction
  72. 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
  73. def semanticEquals(other: Expression): Boolean
    Definition Classes
    Expression
  74. def semanticHash(): Int
    Definition Classes
    Expression
  75. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  76. def simpleString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  77. def simpleStringWithNodeId(): String
    Definition Classes
    Expression → TreeNode
  78. def sql: String
    Definition Classes
    Expression
  79. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  80. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  81. def toJSON: String
    Definition Classes
    TreeNode
  82. def toString(): String
    Definition Classes
    Expression → TreeNode → AnyRef → Any
  83. def transform(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  84. def transformDown(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  85. def transformUp(rule: PartialFunction[Expression, Expression]): Expression
    Definition Classes
    TreeNode
  86. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  87. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  88. final def treeString: String
    Definition Classes
    TreeNode
  89. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  90. final def verboseString(maxFields: Int): String
    Definition Classes
    Expression → TreeNode
  91. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  92. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  93. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  95. def withNewChildren(newChildren: Seq[Expression]): Expression
    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from GpuBatchedRunningWindowWithFixer

Inherited from GpuRunningWindowFunction

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